FIfieldguide
forms

List Fields and current Values for the specified Form

Changed on

Returns every active Field with its current stored Value. Unanswered and cleared Fields have a null Value; formatted-text HTML is returned unchanged.

get/v1/forms/{uuid}/fields

Request

  • Base URL
    https://api.fieldguide.io
  • URL
    https://api.fieldguide.io/v1/forms/{uuid}/fields
  • Auth
    HTTP bearer

Path parameters

uuidstring uuid required

The UUID of the attached Form 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 and current Values visible for the Form

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",
      "value": {
        "value": "Client acceptance response",
        "file_uuid": "7d50d252-be0c-4d69-b77a-5bbdfef83f55",
        "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"
    }
  }
}

Changes