---
title: "List metadata"
method: GET
path: "/metadata"
tags: ["Account"]
---

# List metadata

`GET /metadata`

<small>Requires an API token with one of the following roles: **Document Reader**, **Document Manager**, **Template Reader**, or **Metadata Manager**.</small>

Lists available [metadata](/#metadata) fields that help you enrich your [documents](/#documents).

## Metadata Types

Each metadata has an associated `type` that defines where its value comes from and what actions can be taken on
it.

| Type | Description |
|------|------------ |
| `account` | Custom metadata fields that are specific to your account. |
| `system_reference` | Pre-defined useful metadata fields provided by fynk.  |
| `system_autofilled` | Fields that are automatically filled by the system in response to events, like "Signing completion date". |
| `system_computed` | Fields that are calculated by the system based on other metadata values. e.g. "Signing duration" is the difference between "Signing date" and "Signed date"
| `system` | Other system-provided metadata fields. |

Note that the `type` is distinct from the `value_type`, which controls which kinds of values may be stored in the
field.

> Entries with the `multi_select` value type are only included in the response if you are using API
> [version](/#versioning) `2026-04-02` or newer.

## Response `200`

Array of `MetadataResource`

- object
  - `data` MetadataResource[], required
    - `uuid` string, required
    - `type` 'system_autofilled' | 'system_computed' | 'system' | 'system_reference' | 'account', required
    - `value_type` 'id' | 'uuid' | 'bool' | 'date' | 'duration' | 'email' | 'list' | 'number' | 'currency' | 'currency_duration' | 'clause' | 'select' | 'multi_select' | 'text' | 'textarea' | 'timestamp' | 'array' | 'enum', required
    - `name` string, required
    - `display_name` string, required
    - `settings` MultiFieldSettingsResource, required
      - `currencies` string[], required — For `currency` or `currency_duration` fields, defines the currencies that can be assigned to the field's values
    - `select_values` string[], nullable, required — When `value_type` is `select`, defines the possible values for the metadata's value
    - `always_exists` boolean, required
    - `description` string, nullable, required
    - `keywords` string, nullable, required — Keywords to help with metadata identification.
    - `prompt` string, nullable, required — An AI prompt used for metadata extraction.
    - `is_contract_value` boolean, required — If true, this metadata will be included in the calculated "contract value" if it is present in a document. Only relevant when the value type is one of: `currency`, `currency_duration`
    - `relevant_document_type_uuids` string[], nullable, required — UUIDs of document types this metadata is relevant for. `null` means not relevant to any. `[]` means relevant to all.

## Other responses

- `401` — Unauthenticated
- `403` — Authorization error

---

[API](https://skmtc.dev/fynk/apis/fynk-api-reference.md) · [All operations](https://skmtc.dev/fynk/apis/fynk-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fynk/fynk-api-reference/revisions/9657a6757f59/schema)