Get employees of a company

Get all of the employees, onboarding, active and terminated, for a given company.

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 company

Query Params
string

Filter employees by a specific primary work location

string

Filter employees by a specific payroll

string

A string to search for in the object's names

string

Sort employees by field. Cannot be used with search_term. Options: created_at, name, onboarding_status

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
boolean

Filters employees by those who have completed onboarding

boolean

Filters employees who are ready to work (onboarded AND active today)

boolean

Filters employees by those who have been or are scheduled to be terminated

boolean

Filters employees by those who have been terminated and whose termination is in effect today (excludes active and scheduled to be terminated)

uuids
array of strings

Optional subset of employees to fetch.

uuids
integer

The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.

integer

Number of objects per page. For majority of endpoints will default to 25

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