v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Forms::Fields::Option

List Options

List options for a field

get/forms/fields/{field_id}/options

Path parameters

field_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at' | 'sort_order'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

idinteger

Option ID

public_idstring nullable

Option public ID

field_idinteger

Field ID

labelstring

Label

sort_orderinteger nullable

Sort order

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

Example response

[
  {
    "id": 27,
    "public_id": "gHOzhu",
    "field_id": 10,
    "label": "Test Label",
    "sort_order": 0,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z"
  }
]