Custom Field Options

Custom field options define the choices available for custom fields with the select or multiple select data types.

Following diagram shows custom field options in our data hierarchy:

Custom FieldCustom Field Options

Attributes

archived boolean
Parameter `filter`

Whether this custom field option has been archived and is no longer available for selection.
archived_at string
Response

Timestamp when this option was archived, or null if not archived.
color_id integer
Response Request

ID of the color associated with this option for visual identification.
custom_field custom field
Response

The custom field this option belongs to.
custom_field_id integer
Request Parameter `filter`

ID of the custom field this option belongs to.
name string
Response Request

The display label for this custom field option.
organization organization
Response

The organization this custom field option belongs to.
position integer
Response Request

The sort order of this option within the custom field's option list.

Examples

Loading example

Operations

GET /api/v2/custom_field_options
Get custom field options
POST /api/v2/custom_field_options
Creates a custom field option
GET /api/v2/custom_field_options/{id}
Gets a custom field option
PATCH /api/v2/custom_field_options/{id}
Updates a custom field option
PATCH /api/v2/custom_field_options/{id}/archive
Archives a custom field option