Account

List metadata

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

GET

/metadata

List metadata

curl --request GET \
  --url https://app.fynk.com/v1/api/metadata \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "always_exists": true,
      "description": "The discount rate applied to the company valuation in a follow-on financing round.",
      "display_name": "Discount Rate",
      "is_contract_value": true,
      "keywords": "discount, rate, valuation",
      "name": "discount_rate",
      "prompt": "Extract the discount rate percentage from the document.",
      "relevant_document_type_uuids": [
        "<string>"
      ],
      "select_values": [
        "<string>"
      ],
      "settings": {
        "currencies": [
          "EUR",
          "USD"
        ]
      },
      "type": "system_autofilled",
      "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
      "value_type": "id"
    }
  ]
}

Lists available metadata fields that help you enrich your 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 2026-04-02 or newer.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Array of MetadataResource

dataobject[]required

Show child attributes

Still need help? Share an idea