Read Candidate

Retrieve a candidate's information in Greenhouse.

Input

Field Definition Type Required

Candidate

ID

Unique identifier of this 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

Company

The company where the candidate currently works.

Text

Title

The candidate's current title.

Text

Created At

Date and time when the user was created.

This value is in ISO-8601 format.

Date & Time

Updated At

Date and time when the user was updated.

This value is in ISO-8601 format.

Date & Time

Last Activity

Date and time when the user was last active.

This value is in ISO-8601 format.

Date & Time

Is Private

Returns true if the user is private.

True/False

Attachments

Array of the files attached to this candidate.

List of Objects

Application IDs

Array of application IDs associated with this candidate.

This list can contain none, one, or several application IDs.

List of Numbers

Phone Numbers

Array of the candidate's phone numbers.

List of Objects

Addresses

Array of the candidate's physical 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

Recruiter

The recruiter user who is responsible for this candidate.

Object

Coordinator

The coordinator user who is responsible for this candidate.

Object

Can Email

Returns true if the candidate can be emailed.

True/False

Tags

Array of the candidate's tags.

List of Text

Applications

Array of the candidate's job applications.

List of Objects

Educations

Array of the candidate's education history.

List of Objects

Employments

Array of the candidate's employment history.

List of Objects

Linked User IDs

If the candidate is an internal applicant, this returns the Greenhouse user ID of the candidate.

List of Numbers

Custom Fields

30 customer fields for Candidate records

Based on the actual custom field definitions.

Depends on the actual custom field types

All Custom Fields

The raw payload containing 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.

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.

Related topics

Greenhouse connector

Workflow elements

Greenhouse Harvest API