Sign in
latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

forms

List Fields for the specified Form Template

Lists active Fields for a visible settings-level Form Template. This operation is available only to firm user credentials. Results default to deterministic creation order; sort_by=sequence uses Fieldguide display order.

get/v1/form-templates/{uuid}/fields

Path parameters

uuidstring uuid required

The UUID of the Form Template whose Fields to retrieve

Query parameters

typesFormFieldType[]

Filter Fields by type. Repeat the query parameter for multiple types.

sort_by'created_at' | 'sequence'

Field used to sort Fields. Results are sorted by creation time unless sequence is requested. Sequence order matches Fieldguide, with null sequences first in ascending order and last in descending order.

pagenumber nullable
per_pagenumber nullable
sort_order'asc' | 'desc'

Sort order for paginated results. Use desc to reverse the default ascending order.

Response

The active Fields for the visible Form Template

Example response

{
  "data": [
    {
      "uuid": "4d50d252-be0c-4d69-b77a-5bbdfef83f54",
      "name": "Approval status",
      "sequence": 1,
      "guidance": "<p>Choose the status described in the <a href=\"https://example.com/policy\">policy</a>.</p>",
      "type_metadata": {
        "options": [
          "Approved",
          "Denied"
        ]
      },
      "created_at": "2026-02-01T12:30:00.000Z",
      "updated_at": "2026-03-10T12:30:00.000Z"
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.fieldguide.io/v1/example?page=2&per_page=50"
    },
    "first": {
      "href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
    },
    "last": {
      "href": "https://api.fieldguide.io/v1/example?page=10&per_page=50"
    },
    "previous": {
      "href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
    },
    "next": {
      "href": "https://api.fieldguide.io/v1/example?page=3&per_page=50"
    }
  }
}