List custom field options

GET /api/v3/custom_field_options

The request and response builder is not available for this endpoint. See the OpenAPI specification for complete parameters and schemas.

Fields

Choose fields to return, filter, or sort. Expand a field for examples and associated fields. Collections can only be returned on the top-level resource, not inside an associated resource.

FieldTypeReturned by defaultSortableSupported filters

Unique record ID.

integerYesNoNone

Choice custom field definition that owns the option.

CustomFieldDefinitionNoNo
emptynot_empty

Name of the option.

stringYesYes
eqnot_eqcontainsstarts_withinnot_inemptynot_empty

Color of the option as a hex value.

stringNoYesNone

Whether the option is hidden from selection. Hidden options remain on records that already use them.

booleanNoNoNone

Position of the option among its siblings. Options of conditional choice fields are ordered under their parent.

integerNoYes
eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty

Parent option of a conditional choice field option; set on create only and null for other options.

stringNoYes
eqnot_eqcontainsstarts_withinnot_inemptynot_empty

Date and time when the record was created.

date-timeNoYes
eqgtgteltltebetweenemptynot_empty

Date and time when the record was last updated.

date-timeNoYes
eqgtgteltltebetweenemptynot_empty

Search matches the start of a field path and includes matching associations’ subfields. Use a dotted path to search within a specific association.

Query syntax

Return selected fields with a comma-separated fields parameter, or add a field to the defaults with fields=default,{field}. Expand an association above for its supported subfields and selection examples.

Filter with filter.{operator}[{field}]=value. Multiple filters combine with AND. Use comma-separated values for in and not_in, two inclusive bounds for between, and true for empty and not_empty.

Sort with sort.asc={field} or sort.desc={field}. Explicit sorting limits results to 1,000 records. Omit sorting to retrieve all results in descending ID order.

Set the page size with per_page. Follow pagination.next_url while pagination.has_more is true.

Filter operators

eq equals; not_eq does not equal; contains contains text; starts_with starts with text (both case-insensitive).

gt greater than; gte greater than or equal; lt less than; lte less than or equal.

in matches any listed value; not_in excludes listed values; between matches an inclusive range; empty and not_empty check for an absent or present value.

See field selection, filtering, and pagination and sorting limits for details.

© 2026 Aha! Labs Inc. • All rights reserved