List Candidates

List all of an organization's candidates who are currently in Greenhouse.

Options

Field	Definition	Type	Required
Result Set	Choose one of the following options to display your search results: First 200 Records Stream Records: Passes all matching records from your parent flow to a helper flow. Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add custom extensible fields.	Dropdown	TRUE

Field

Definition

Type

Required

Result Set

Choose one of the following options to display your search results:

First 200 Records
Stream Records: Passes all matching records from your parent flow to a helper flow.

Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add custom extensible fields.

Dropdown

TRUE

Input

Field	Definition	Type	Required
List Criteria
Created Before	Return only users that were created before the specified timestamp. The timestamp must be in ISO-8601 format.	Date & Time	FALSE
Created After	Return only users that were created after the specified timestamp. The timestamp must be in ISO-8601 format.	Date & Time	FALSE
Updated Before	Return only users that were updated before the specified timestamp. The timestamp must be in ISO-8601 format.	Date & Time	FALSE
Updated After	Return only users that were updated after the specified timestamp. The timestamp must be in ISO-8601 format.	Date & Time	FALSE
Job ID	If supplied, the results return only candidates that have applied to the specific job. Returns results for when a candidate has applied to a job and when they're a prospect for a job.	Number	FALSE
Email	If supplied, the results return only candidates who have a matching email address. If supplied with along with a Job ID, the results only return candidates with a matching email and an application for the specific job. If Email and Candidate IDs are both included, Candidate IDs are ignored.	Text	FALSE
Candidate IDs	If supplied, the results return only the candidates with the given IDs. These are supplied as a comma-separated string. For example, candidate_ids=123,456,789. When combined with Job ID, the results return only candidates with an application for the specific job. A maximum of 50 candidates can be returned this way.	Text	FALSE
Streaming
Flow	Click Choose Flow to browse and select a helper flow as the destination for the streamed search results. Click Choose to confirm. Optionally, you can click the empty field under Click or drop here to create to add custom extensible fields that pass data to the helper flow. These fields are added as key and value pairs under the State output object in the helper flow. This field appears when Stream Records is selected from the Result Set field.	Flow	TRUE
Record Limit	Specify the number of records to stream. When the Record Limit field is set to 0 or a negative number, the card returns an error. When the Record Limit field is set to greater than 0, the stream returns up to the maximum number specified. When the Record Limit field is empty, null, or not selected, the stream returns all records. The default value is 500000. The valid range is from 0 to 500000. This field appears when Stream Records is selected from the Result Set option.	Number	FALSE

Output

Field	Definition	Type
Result
Candidates	This field appears if you select First 200 Records from the Result Set option. This field is a list of objects and each object contains the following fields.	List of Objects
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	An object containing all the custom fields of this candidate. You can use the Object Get function card to locate any custom field from within the Custom Fields output.	Object
Result
Records Streamed	This field appears if you select Stream Records from the Result Set option. The number of streamed records.	Number

List Candidates

Options

Input

Output

Related topics