Skip to main content
GET
/
smart-fields
/
{id}
/
options
List options for a select/multiselect smart field
curl --request GET \
  --url https://api.tomorro.com/v2/smart-fields/{id}/options \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "translations": [
        {
          "language": "gb",
          "value": "Technology"
        }
      ],
      "integrationMappings": []
    }
  ],
  "pagination": {
    "limit": 20,
    "next_cursor": "eyJpZCI6IjEyMyJ9",
    "prev_cursor": null,
    "has_next": true,
    "has_previous": false
  },
  "links": {
    "self": "/smart-fields/550e8400/options?limit=20",
    "next": "/smart-fields/550e8400/options?limit=20&after=eyJpZCI6IjEyMyJ9",
    "prev": null
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your key at https://app.tomorro.com/settings/integrations?integration=api-key

Path Parameters

​
id
string
required

The smart field ID.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Query Parameters

​
limit
number
default:20

Number of items per page (1-50)

Required range: 1 <= x <= 50
Example:

20

​
after
string

Cursor for forward pagination. Use the next_cursor value from a previous response.

Example:

"eyJpZCI6IjEyMyJ9"

​
before
string

Cursor for backward pagination. Use the prev_cursor value from a previous response.

Example:

"eyJpZCI6IjEwMCJ9"

​
term
string

Filter options by label (partial match).

Example:

"Technology"

Response

Paginated list of options with cursor pagination info

​
data
object[]
required

An array of SmartFieldOption objects.

Example:
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "translations": [{ "language": "gb", "value": "Technology" }],
    "integrationMappings": []
  }
]
​
pagination
object
required

Pagination metadata including cursors and navigation flags.

Example:
{
  "limit": 20,
  "next_cursor": "eyJpZCI6IjEyMyJ9",
  "prev_cursor": null,
  "has_next": true,
  "has_previous": false
}
​
links
object
required

HATEOAS navigation links for pagination.

Example:
{
  "self": "/smart-fields/550e8400/options?limit=20",
  "next": "/smart-fields/550e8400/options?limit=20&after=eyJpZCI6IjEyMyJ9",
  "prev": null
}