Custom Field Options V1

Manage custom field options.

Single- and multi-select custom fields have a list of all available options, which have a value, and a sort key. The value must be unique to the custom field. For example, you might have an Incident Type custom field, with options "Data breach", "Performance degradation", "API downtime", etc.

List Custom Field Options V1

Show custom field options for a custom field

Request
query Parameters
page_size
integer <int64>
Default: 25

number of records to return

Example: page_size=25
after
string

A custom field option's ID. This endpoint will return a list of custom field options created after this option.

Example: after=01G0J1EXE7AXZ2C93K61WBPYEH
custom_field_id
required
string

The custom field to list options for.

Example: custom_field_id=01FCNDV6P870EA6S7TK1DSYD5H
Responses
200

OK response.

get/v1/custom_field_options
Request samples 
Response samples 
application/json
{
  • "custom_field_options": [
    ],
  • "pagination_meta": {
    }
}
Create Custom Field Options V1
Create a custom field option. If the sort key is not supplied, it'll default to 1000, so the option appears near the end of the list.


Request 
Request Body schema: application/json
required
custom_field_id
required
string
ID of the custom field this option belongs to


 
sort_key
integer <int64> 
 Default:  1000
Sort key used to order the custom field options correctly


 
value
required
string
Human readable name for the custom field option


 
Responses 
201
Created response.


post/v1/custom_field_options
Request samples 
application/json
{
  • "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0",
  • "sort_key": 10,
  • "value": "Product"
}
Response samples 
application/json
{
  • "custom_field_option": {
    }
}
Delete Custom Field Options V1
Delete a custom field option


Request 
path Parameters
id
required
string
Unique identifier for the custom field option


 
 Example:  01FCNDV6P870EA6S7TK1DSYDG0
Responses 
204
No Content response.


delete/v1/custom_field_options/{id}
Request samples 
Show Custom Field Options V1
Get a single custom field option


Request 
path Parameters
id
required
string
Unique identifier for the custom field option


 
 Example:  01FCNDV6P870EA6S7TK1DSYDG0
Responses 
200
OK response.


get/v1/custom_field_options/{id}
Request samples 
Response samples 
application/json
{
  • "custom_field_option": {
    }
}
Update Custom Field Options V1
Update a custom field option


Request 
path Parameters
id
required
string
Unique identifier for the custom field option


 
 Example:  01FCNDV6P870EA6S7TK1DSYDG0
Request Body schema: application/json
required
sort_key
required
integer <int64> 
 Default:  1000
Sort key used to order the custom field options correctly


 
value
required
string
Human readable name for the custom field option


 
Responses 
200
OK response.


put/v1/custom_field_options/{id}
Request samples 
application/json
{
  • "sort_key": 10,
  • "value": "Product"
}
Response samples 
application/json
{
  • "custom_field_option": {
    }
}
➔ Next to Custom Fields V1