v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

List Custom Field Options

Get a list of options for a multi-select custom field.<br><br>You can use the query params to filter for a single matching custom field option.

get/v1/custom-fields/{id}/options

Path parameters

idstring required

The ID of the multi-select custom field to list options for.

Query parameters

labelstring

Only the option with a label that matches the value provided here will be returned.

Response

200

Example response

{
  "data": [
    {
      "id": "option-e770d1fe-bbfc-484e-92c5-279e5bec4437",
      "key": "gold",
      "label": "Gold",
      "color": "rgba(144, 149, 157, 1)",
      "object": "customFieldOption"
    }
  ]
}