Read User

Retrieve a user's information 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

  • Primary Email: The primary email address that's stored in Greenhouse for the user

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

 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

Primary Email

The primary email address that's 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

Last name of the user. Text

Primary Email Address

The email address this user designated as their primary address.

 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

Job Title

The job title that's associated with the user.

 Text

Deactivated

Returns true if the user is deactivated.

 True/False

Site Admin

Returns true if the user is a site administrator.

 True/False

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

Contains 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

The IDs of the offices that are associated with the user.

 List of Numbers

Departments IDs

The IDs of the departments that are associated with the user.

 List of Numbers

Interviewer Tags

An array that contains the ID and name of the interviewer tags that are associated with this user.

 List of Objects

Custom Fields

Custom fields for user records

Based on the actual custom field definitions.

Depends on the actual custom field types

All Custom Fields

The raw payload that contains 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.