---
title: "Get field metadata"
method: GET
path: "/fields/{field_id}/metadata"
tags: ["Fields"]
---

# Get field metadata

`GET /fields/{field_id}/metadata`

## Request

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

Gets field metadata and returns `field_id`, `name`, `description`, `read_only`, `is_trained`, `file_ids`

## Path parameters

- `field_id` string, required

## Response `200`

The field's metadata

- FieldMetadataResponse
  - `description` string, required
  - `document_types` ClassificationPercentage[], required
    - `classifications` string[], required
    - `percentage` number, required
  - `field_id` string, required
  - `file_ids` string[], 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
  - `read_only` boolean, required
  - `tags` string[], required

## Other responses

- `400`: Invalid field ID
- `404`: Field not found.
- `500`: Internal Server Error

## Changes

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

[Operation history](https://skmtc.dev/zuva/apis/zuva-docai/changes/fields/:field_id/metadata/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)