GEgem
Custom Fields

Get custom field by ID

Returns the custom field object with the corresponding ID.

get/v0/custom_fields/{custom_field_id}

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

Response

OK

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.

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.

Changes

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