GEgem
Custom Field Options

List options in a custom field

Returns a list of all custom fields options in a single_select or multi_select custom field.

get/v0/custom_fields/{custom_field_id}/options

Request

  • Base URL
    https://api.gem.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.gem.com/v0/custom_fields/{custom_field_id}/options
  • Auth
    none declared

Query parameters

valuestring

Value of an option in the custom field. Any leading and trailing spaces of the option value will be removed.

is_hiddenboolean

hidden options are not selectable in the Gem product. Candidate custom field values with hidden options are not returned when making a query to the Candidates endpoint.

pageinteger
page_sizeinteger

Response

OK

idstring ObjectID
valuestring
is_hiddenboolean

hidden options are not selectable in the Gem product. Candidate custom field values with hidden options are not returned when making a query to the Candidates endpoint.

Changes

No recorded changes to this operation across all 1 revision of this API.