Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Candidate Educations

List candidate educations

Candidate educations are the school/degree/discipline entries on a candidate's profile — one row per education entry. V3 flattens what V1 nested under /v1/candidates/{id}/educations; filter with candidate_ids to retrieve a single candidate's full education history. School, degree, and discipline are stored as references to custom-field option ids — resolve the display names via /v3/custom_field_options. Use latest=true to retrieve only each candidate's most recent education.

get/v3/candidate_educations

Query parameters

cursorstring

Cursor link for pagination from previous page response header. Do not use any other parameters when using this.

per_pageinteger

Number of results per page

idsinteger[]

Comma separated list

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
candidate_idsinteger[]

Comma separated list

fieldsstring[]

Comma separated list of fields to return

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by education start date. Pass any combination of gte, lte, gt, lt as ISO-8601 date-times (e.g. start_at[gte]=2014-01-01T00:00:00Z).

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by education end date. Pass any combination of gte, lte, gt, lt as ISO-8601 date-times (e.g. end_at[lte]=2018-12-31T00:00:00Z).

latestboolean

When true, return only each candidate's most recent education entry; when false, exclude the most recent. Omit to include the full education history.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
candidate_idinteger

Id of the candidate (person) this education entry belongs to.

school_name_custom_field_option_idinteger nullable

Id of the custom-field option representing the school. Resolve the display name via GET /v3/custom_field_options?ids=<id>; the school dictionary lives under the org's school_name custom field.

degree_custom_field_option_idinteger nullable

Id of the custom-field option representing the degree (e.g. Bachelor's, Master's). Resolve the display name via GET /v3/custom_field_options?ids=<id>; the degree dictionary lives under the org's degree custom field.

discipline_custom_field_option_idinteger nullable

Id of the custom-field option representing the field of study (e.g. Computer Science). Resolve the display name via GET /v3/custom_field_options?ids=<id>; the discipline dictionary lives under the org's discipline custom field.

start_atstring date-time nullable

Start date the education entry covers, in ISO 8601. Only the month and year are surfaced on the candidate profile; any day/time component is stored but ignored by the Greenhouse UI.

end_atstring date-time nullable

End date the education entry covers, in ISO 8601. null for in-progress education. Only the month and year are surfaced on the candidate profile.

latestboolean

true when this is the candidate's most recent education (by end_at). Greenhouse maintains this flag automatically — at most one education per candidate has latest: true.

start_date_monthinteger nullable

Month component (1-12) of the education's start, when only month/year granularity is known.

start_date_yearinteger nullable

Year component (e.g. 2014) of the education's start, when only month/year granularity is known.

end_date_monthinteger nullable

Month component (1-12) of the education's end, when only month/year granularity is known.

end_date_yearinteger nullable

Year component (e.g. 2018) of the education's end, when only month/year granularity is known.