Read User

Retrieve the details for a specific user ID in Greenhouse.

Options

Field Definition Type Required

Read By

Choose one option to identify the user record. There are three options:

  • User ID: The Greenhouse user ID

  • Email: The email address that is stored in Greenhouse for the user

  • Employee ID: The user's employee ID, if available

Any of the email addresses assigned to the user's account can be used for the look up action. However, an email address can't be included in more than one user account.

Dropdown

TRUE

Input

The input section displays only one of these fields, based on the selection in the Read By option.

Field Definition Type Required

ID

Unique identifier of the user.

Number

TRUE

Email

Any of the email addresses associated with this user.

Text

TRUE

Employee ID

Unique external ID of the user.

Text

TRUE

Output

Field Definition Type

Basic Information

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.

Date & Time

Created At

Date and time when the object was created.

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

Contains 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

30 customer fields for User 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 user.

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 Users Custom Options configuration page. It's also the same order as the custom fields shown on the user information page when editing a specific user.

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.

Related topics

Greenhouse connector

Workflow elements

Greenhouse Harvest API