List custom field options

List every enum option configured for a custom field definition in the Terminal49 API. Use this to populate selectors in your tracking UI or app.

GET /custom_field_definitions/{definition_id}/options

List custom field options

cURL

curl --request GET \
  --url https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options \
  --header 'Authorization: <api-key>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {
        "label": "<string>",
        "value": "<string>",
        "position": 123
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 123,
    "total": 123
  }
}

List all options for a custom field definition.

Path parameters

Parameter	Description
definition_id	The unique identifier of the custom field definition

Authorizations

Authorization · string · header · required

Use a Terminal49 API key in the Authorization header with the Token prefix.

Authorization: Token YOUR_API_KEY

Path Parameters

definition_id · string · required

Custom field definition ID

Response

200 - application/json

OK

data · Custom field option · object[]

Show child attributes

links · links · object

Show child attributes

meta · meta · object

Show child attributes