Custom Fields

List custom fields

Returns a list of all custom fields. Supports pagination and search parameters created_after, created_before.

get/v0/custom_fields

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
Auth
none declared

Query parameters

created_afterinteger

created_beforeinteger

sort'asc' | 'desc'

project_idstring ObjectID nullable

Only applicable when scope is project.

scope'team' | 'project'

Custom fields under team scope apply to all candidates. Custom fields under project scope apply to candidates in a specific project.

is_hiddenboolean

hidden custom fields in the candidate info are not displayed in the Gem product or not returned when making a query on the Candidates endpoint.

namestring

Any leading and trailing spaces of the name string will be removed.

pageinteger

page_sizeinteger

Response

idstring ObjectID

created_atinteger

namestring

value_type'date' | 'text' | 'single_select' | 'multi_select'

When value_type is text, value is a string. When value_type is date, value is a string of format yyyy-mm-dd. When value_type is single_select, value is a string of an option value. When value_type is multi_select, value is an array of strings of option values.

scope'team' | 'project'

Custom fields under team scope apply to all candidates. Custom fields under project scope apply to candidates in a specific project.

project_idstring ObjectID

If the custom field has project scope, this is the project ID that its associated with.