Custom fields

List options for a custom field

Changed on

Custom fields are defined by record type, and are shared across all workspaces across the account. Fields must be added to a layout before they will appear on a record.

For custom fields that include options, (e.g. tags, choice lists), you can also load the list of all available options.

get/custom_field_definitions/{custom_field_definition_id}/options

Request

Path parameters

custom_field_definition_idstring required

CustomFieldDefinitionId identifier

Response

Successful operation

Example response

{
  "options": [
    {
      "text": "P1",
      "value": "486420793",
      "meta": {
        "color": "#666666"
      }
    },
    {
      "text": "P2",
      "value": "100098181",
      "meta": {
        "color": "#666666"
      }
    },
    {
      "text": "P3",
      "value": "854609942",
      "meta": {
        "color": "#666666"
      }
    },
    {
      "text": "P4",
      "value": "747947447",
      "meta": {
        "color": "#666666"
      }
    },
    {
      "text": "P5",
      "value": "462681378",
      "meta": {
        "color": "#666666"
      }
    }
  ]
}

Changes