List Users

List all of an organization's users 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 users that were created before the specified time stamp. The time stamp must be in ISO-8601 format.	Date & Time	FALSE
Created After	Return only users that were created after the specified time stamp. The time stamp must be in ISO-8601 format.	Date & Time	FALSE
Updated Before	Return only users that were updated before the specified time stamp. The time stamp must be in ISO-8601 format.	Date & Time	FALSE
Updated After	Return only users that were updated after the specified time stamp. The time stamp must be in ISO-8601 format.	Date & Time	FALSE
Office IDs	If supplied, the results return only users associated with the specified office IDs. Provide multiple office IDs as a comma-separated string. For example, `office_ids=123,456,789`. A maximum of 50 IDs are allowed this way.	Text	FALSE
Department IDs	If supplied, the results return only users associated with the specified department IDs. Provide multiple department IDs as a comma-separated string. For example, `department_ids=123,456,789`. A maximum of 50 IDs are allowed this way.	Text	FALSE
Linked Candidate IDs	If supplied, the results return only users linked to the specified candidate IDs. Provide multiple candidate IDs as a comma-separated string. For example, `linked_candidate_ids=123,456,789`. A maximum of 50 IDs are allowed this way.	Text	FALSE
Interviewer Tag IDs	If supplied, the results return only users associated with the specified interviewer tag IDs. Provide multiple interviewer tag IDs as a comma-separated string. For example, `interviewer_tag_ids=123,456,789`. A maximum of 50 IDs are allowed this way.	Text	FALSE
Is Deactivated	If supplied, the results return users based on their deactivation status. Set to `true` to return only deactivated users. Set to `false` to return only active users.	True/False	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 you set the Record Limit field to `0` or a negative number, the card returns an error. When you set the Record Limit field 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 you select `Stream Records` from the Result Set option.	Number	FALSE

The employee_id and email query parameters mentioned in the List Users API documentation aren't included in the List Criteria. That query only returns a single user, similar to the Read User card. So instead, those parameters appear on the Read User card as the Email and Employee ID choices for the Read By option.

Output

Field	Definition	Type
Result	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 user.	Number
Name	Name of the user.	Text
First Name	Given name of the user.	Text
Last Name	Last name of the user.	Text
Preferred Name	Preferred name of the user.	Text
Primary Email Address	The email address this user designated as their primary address. This value is included in the Emails result.	Text
Timezone	Time zone of the user.	Text
Updated At	Date and time when the object was updated. This value is in ISO-8601 format.	Date & Time
Created At	Date and time when the object was created. This value is in ISO-8601 format.	Date & Time
Deactivated	Returns true if the user is deactivated.	True/False
Site Admin	Returns true if the user is a site administrator.	True/False
Emails	The list of the email addresses associated with this user.	List of Text
Employee ID	Unique external ID of the user.	Text
Agency ID	The unique identifier of the agency that's associated with the user.	Text
Linked Candidate IDs	The IDs of candidate records that contain this user's personal applications. These are the records that contain this user's personal interview records and other information.	List of Numbers
Offices IDs	An array of offices IDs that are associated with this user. This list can contain none, one, or several offices IDs.	List of Numbers
Departments IDs	An array of departments IDs that are associated with this user. This list can contain none, one, or several departments IDs.	List of Numbers
Interviewer Tags	An array containing the ID and name of the interviewer tags that are associated with this user.	List of Objects
Custom Fields	An object that contains all the custom user fields specific to your organization. Note: Custom Fields data is structured as an object of nested objects. For example: `{ "custom_fields": { "location": { "name": "Location", "type": "single_select", "value": "Home" }, "device": { "name": "Device", "type": "multi_select", "value": null }, "remote": { "name": "Remote", "type": "boolean", "value": true } } }` You can use an Object Get card with the path set to `Custom Fields` and then select the nested field's value to pull it directly from the output.	List of Objects
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 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, but the action might increase the overall run time.