List User Field Options

GET {{baseUrl}}/api/v2/user_fields/:user_field_id/options

Returns a list of custom user field options for the given dropdown user field.

Pagination

  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Allowed For

  • Agents

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"count":2,"custom_field_options":[{"id":10000,"name":"Apples","position":0,"raw_name":"Apples","url":"http://{subdomain}.zendesk.com/api/v2/user_fields/1/options/10000.json","value":"apple"},{"id":10001,"name":"Bananas","position":1,"raw_name":"Bananas","url":"http://{subdomain}.zendesk.com/api/v2/user_fields/1/options/10001.json","value":"banana"}],"next_page":null,"previous_page":null}