List all field options

Lists the options of the account's dropdown, listbox, radio, and checkbox custom contact fields, 20 per page by default. Use field to list one custom field's options; that and ids are the only supported filters on this endpoint. filters[...] and orders[...] parameters are not supported here and are silently ignored, so the response looks filtered but is not. Each entry's id is a field option id: it is valid only on the fieldOptions endpoints and must never be passed to /fields/{id}, which addresses whole custom field definitions in a separate id space. Each entry's field property holds the id of the field definition it belongs to. meta.total is the number of matching options, returned as a string; it is null whenever field is set.

Query Params
string

Return only the options of this custom field definition id. Exact match.

string

Comma-separated list of field option ids to fetch. Unlike most list endpoints, ids does not change the page size here: limit (default 20) still applies, so pass a limit at least as large as the number of ids.

integer

Number of options per page. Default 20. There is no maximum, and 0 returns every option (offset is then ignored).

integer

Number of options to skip, for pagination.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json