List Candidates

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

Options

Field Definition Type Required

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

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 candidates that were created before the specified time stamp. The time stamp must be in ISO-8601 format. Note: Enter the date in the exact format `YYYY-MM-DDTHH:mm:ss.SSSZ`.	Date & Time	FALSE
Created After	Return only candidates that were created after the specified time stamp. The time stamp must be in ISO-8601 format. Note: Enter the date in the exact format `YYYY-MM-DDTHH:mm:ss.SSSZ`.	Date & Time	FALSE
Updated Before	Return only candidates that were updated before the specified time stamp. The time stamp must be in ISO-8601 format. Note: Enter the date in the exact format `YYYY-MM-DDTHH:mm:ss.SSSZ`.	Date & Time	FALSE
Updated After	Return only candidates that were updated after the specified time stamp. The time stamp must be in ISO-8601 format. Note: Enter the date in the exact format `YYYY-MM-DDTHH:mm:ss.SSSZ`.	Date & Time	FALSE
Job ID	If supplied, the results return only candidates who 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 along with a Job ID, the results only return candidates with a matching email and an application for the specific job.	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`. A maximum of 50 candidates can be returned this way.	Text	FALSE
Last Activity At	Return only candidates that were last active after the specified time stamp. The time stamp must be in ISO-8601 format. Note: Enter the date in the exact format `YYYY-MM-DDTHH:mm:ss.SSSZ`.	Date & Time	FALSE
Tag	The tag that's associated with the candidate's profile.	Text	FALSE
Custom Filter
Filter	To make your search more flexible, provide a user API attribute name with value. Provide filters as key and value pairs separated by `&`. For example: `attr1=value1&attr2=value2&attr3=value3`.	Text	FALSE
Streaming
Flow	Select Choose Flow to browse and select a helper flow as the destination for the streamed search results. Select Choose to confirm. Optionally, you can select 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`. When the Record Limit field is set to greater than `500000`, the card returns an error. This field appears when you select `Stream Records` from the Result Set option. Note: If a decimal value is provided, the fractional part is truncated, and the value rounds down to the nearest lower integer. For example, `10.99` becomes `10`, and `5.25` becomes `5`.	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
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 was created. This value is in ISO-8601 format.	Date & Time
Updated At	Date and time when the candidate was updated. This value is in ISO-8601 format.	Date & Time
Last Activity	Date and time when the candidate was last active. This value is in ISO-8601 format.	Date & Time
Is Private	Returns true if the candidate profile is restricted to users with View Private Candidates access.	True/False
Attachments	Array of the files attached to this candidate.	List of Objects
Application IDs	Array of application IDs that are 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 who's responsible for this candidate.	Object
Coordinator	The coordinator who's is responsible for this candidate.	Object
Can Be Emailed	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 that contains all the custom fields of this candidate. Note: The Custom Fields output is structured as an object of nested objects. For example: `{ "custom_fields": { "work_remote": { "name": "Work Remote", "type": "boolean", "value": true }, "desired_salary_currency": { "name": "Desired Salary Currency", "type": "currency", "value": { "unit": "GBP", "value": "1235790876.0" } }, "desired_salary": { "name": "Desired Salary", "type": "number", "value": "23457.0" } } }` 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

CAUTION:

If your records contain many custom fields or data, you can enter a smaller per_page value in the Custom Filter field (for example, per_page=10). This controls the number of records received per request. The total number of records returned remains the same, though the action may increase the overall run time.