List Users
List all of an organization's users who are currently in Greenhouse.
Options
| Field | Definition | Type | Required |
|---|---|---|---|
|
Result Set |
Choose one of the following options to display your search results:
|
Dropdown |
TRUE |
|
Include Custom Fields |
Choose an option to update inputs:
|
Dropdown |
FALSE |
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 |
| 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.
This field appears when Stream Records is selected from the Result Set option. |
Number |
FALSE |
The employee_id and email query parameters mentioned in the List Users API documentation isn'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 |
Family 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 |
|
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 |
|
Disabled |
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 |
|
Linked Candidate IDs |
The IDs of candidate records containing this user's personal applications. These are the records containing this user's personal interview records and other information. |
List of Numbers |
|
Offices |
An array containing the offices this user is associated with. |
List of Objects |
|
Departments |
An array containing the departments this user is associated with. |
List of Objects |
|
Custom Fields |
An object that contains all the custom user fields specific to your organization. You can use the Object Get function card to locate any custom field from within the Custom Fields 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 |