---
title: "Get field list"
method: GET
path: "/fields"
tags: ["Fields"]
---

# Get field list

`GET /fields`

## Request

- Base URL: `https://us.app.zuva.ai/api/v2`
- URL: `https://us.app.zuva.ai/api/v2/fields`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/zuva/apis/zuva-docai/docs/fields/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists all fields available to the user.

Metadata for non-custom fields will include all properties, but the scores (precision, recall etc.) will be zero.

## Response `200`

List of fields with metadata.

- FieldListResponseElement[]
  - `bias` number, required
  - `description` string, required
  - `document_count` integer, required
  - `document_types` ClassificationPercentage[], required
    - `classifications` string[], required
    - `percentage` number, required
  - `f_score` number, required
  - `field_id` string, required
  - `file_ids` string[], required
  - `is_custom` boolean, required
  - `is_trained` boolean, required
  - `jurisdictions` Jurisdiction[], required
    - `country` Country, required
      - `code` string, required: The ISO 3166-1 alpha-2 code, eg. "CA".
      - `name` string, required: The ISO 3166 country name, eg. "Canada".
    - `regions` string[], required: Any additional state/provincial specifications, eg. ["British Columbia", "Ontario"].
  - `languages` LanguagePercentage[], required
    - `language` string, required
    - `percentage` number, required
  - `name` string, required
  - `normalization_type` string, required
  - `precision` number, required
  - `recall` number, required
  - `tags` string[], required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Request not found.
- `500`: Internal Server Error

## Changes

- **2022-12-13** `7cace20deba7`: 5 info
  - added the required property `items/document_types` to the response with the `200` status
  - added the required property `items/jurisdictions` to the response with the `200` status
  - added the required property `items/languages` to the response with the `200` status
  - added the required property `items/normalization_type` to the response with the `200` status
  - …1 more

[Operation history](https://skmtc.dev/zuva/apis/zuva-docai/changes/fields/get.md)

---

[API](https://skmtc.dev/zuva/apis/zuva-docai.md) - [All operations](https://skmtc.dev/zuva/apis/zuva-docai/llms.txt) - [OpenAPI document](https://skmtc.dev/zuva/apis/zuva-docai/revisions/7397ad071d55?raw)