Get an employee

Get an employee.

Note: Compensation data (pay rate, payment unit, and related fields) represents sensitive employee pay information. When retrieving employee job data, these fields (rate, payment_unit, current_compensation_uuid, compensations) are returned only when the compensations:read scope is included. This allows you to access employee and job metadata without exposing pay rates.

scope: employees:read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The UUID of the employee

Query Params
include
array of strings

Include the requested attribute(s) in each employee response. Multiple options are comma separated.

Show Details
all_compensationsInclude all effective dated compensations for each job instead of only the current compensation. Requires `compensations:read` scope.
all_home_addressesInclude all home addresses that have been associated to this employee
company_nameInclude the name of the company that the employee is associated with
current_home_addressInclude the employee's current home address
custom_fieldsInclude employees' custom fields
portal_invitationsInclude portal invitation status information, including member portal invitation details and partner portal invitation status
include
Headers
string
enum
Defaults to 2026-02-01

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json