Read Candidate

Retrieve a candidate's information in Greenhouse.

Input

Field	Definition	Type	Required
Candidate
ID	Unique identifier of the candidate.	Number	TRUE

Output

Field	Definition	Type
Basic Information
ID	Unique identifier of the candidate.	Number
First Name	Given name of the user.	Text
Last Name	Last name of the user.	Text
Preferred Name	The candidate's preferred name.	Text
Timezone	The candidate's time zone. Note: The output of this field can't be used in input of other candidate card.	Text
Company	The company where the candidate currently works.	Text
Title	The candidate's current title.	Text
Created At	Date and time when the candidate profile was created. This value is in ISO-8601 format.	Date & Time
Updated At	Date and time when the candidate profile was updated. This value is in ISO-8601 format.	Date & Time
Last Activity At	Date and time when the candidate was last active. This value is in ISO-8601 format.	Date & Time
Is Private	If true, the candidate profile is restricted to users with View Private Candidates access.	True/False
Phone Numbers	Array of the candidate's phone numbers.	List of Objects
Addresses	Array of the candidate's postal addresses.	List of Objects
Email Addresses	Array of the candidate's email addresses.	List of Objects
Website Addresses	Array of the candidate's website addresses.	List of Objects
Social Media Addresses	Array of the candidate's social media addresses.	List of Objects
Can Be Emailed	Returns true if the candidate can be emailed.	True/False
Tags	Array of the candidate's tags.	List of Text
Linked User IDs	Greenhouse user IDs linked to the candidate if they're an internal applicant.	List of Numbers
Custom Fields
Custom fields for candidate records.	Based on the actual custom field definitions.	Depends on the actual custom field types
All Custom Fields	The raw payload that contains all custom fields of this candidate.	Object

This card has 30 individual fields listed under the Custom Fields output group so you can retrieve those popular custom fields easily.

These 30 custom fields returned are the top 30 custom fields in the order shown on your Candidates Custom Options configuration page. It's also the same order as the custom fields shown on the information page when editing a specific candidate.

Note:

If you have over 500 existing custom fields, and manually move a field from a position above 500 to within the first 30 fields, it may not be included in the 30 custom field outputs. In this case, you can use the Object.Get function card to locate any custom field from within the All Custom Fields output.

The School Name, Degree, and Discipline don't appear on your Candidates Custom Options configuration page. The system configures these three fields by default and so they aren't returned inside the custom_fields payload from the Read Candidate endpoint.