Document Operations

List document's dynamic fields

Changed on

<small>Requires an API token with the Document Reader role.</small>

Lists a document's dynamic fields and their values.

Filtering

The dynamic field list can be filtered by visibility. The available filter attributes are listed under filter in the Query Parameters section of this page.

To specify filters, use array notation in the request query string to specify one or more filter values.

For example, to filter for only fields that appear in the rendered document content, the query string should contain:

filter[visibility]=visible

Entries with the multi_select value type are only included in the response if you are using API version 2026-04-02 or newer.

get/documents/{document}/dynamic-fields

Request

  • Base URL
    https://app.fynk.com/v1/api
  • URL
    https://app.fynk.com/v1/api/documents/{document}/dynamic-fields
  • Auth
    HTTP bearer

Path parameters

documentstring required

The document UUID

Query parameters

filter[visibility]'all' | 'visible' | 'not_visible'

Filters the returned fields by whether they appear in the document. visible returns only fields that are rendered into the document's content, or, for PDF-based documents, placed on one of its pages. not_visible returns only fields that are not, including fields that are referenced by a condition but never rendered. The default is all, which returns every field.

Response

Array of DynamicFieldResource

Example response

{
  "data": [
    {
      "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
      "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Gross salary",
      "settings": {
        "currencies": [
          "EUR",
          "USD"
        ]
      },
      "format": {
        "decimals": 2,
        "decimal_separator": ".",
        "thousands_separator": ","
      },
      "question": "What is the employee's gross salary in EUR?"
    }
  ]
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the new optional query request parameter filter[visibility]

    • info

      added the non-success response with the status