GET Employees

Retrieves the list of active employees currently provisioned within the application. The fields retrieved depend on the employee scopes that you have access to for your access token or API key. The only guarenteed fields include id, personalEmail, and roleState.

For optimal performance, ensure pagination is used via our limit and offset parameters. Pagination should be set to a maximum of 100.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer

Sets a limit on the returned values

offset · integer

Offsets the returned values

Response

200 - application/json

OK

id · string

This is the unique role ID of the employee. A role ID exists per 1 and only 1 company.

userId · string

This is the unique user ID of the employee. A userID can span across 1 or many companies.

name · string

Full name of the employee

preferredFirstName · string

preferredLastName · string

firstName · string

First name of the employee

lastName · string

Last name of the employee

employmentType · enum<string>

An ENUM of employment type

Available options:

CONTRACTOR,

SALARIED_FT,

SALARIED_PT,

HOURLY_FT,

HOURLY_PT,

TEMP

title · string

The employee's work title

gender · enum<string>

The employee's gender

Available options:

MALE,

FEMALE

identifiedGender · enum<string>

The employee's identified gender

Available options:

MALE,

FEMALE,

NONBINARY

department · string

The employee's department name

workLocation · object | null

An address object as stored within Rippling.

Show child attributes

worklocationNickname · string

The work location nickname

spokeId · string | null

endDate · string | null

The employee's end date

roleState · enum<string>

The employee's role status - roleState meanings:

INIT: An initial record of an individual. An offer has not been made and they have not started working at the company.

HIRED: An offer has been made but they have not accepted or started yet.

ACCEPTED: An offer has been made and they have accepted, but they have not started yet.

ACTIVE: The employee currently works at the company and their start date is today or in the past.

TERMINATED: The employee is no longer active.

Available options:

INIT,

HIRED,

ACCEPTED,

ACTIVE,

TERMINATED

workEmail · string | null

The employee's work email

manager · string

The unique identifier of the employee's manager. This value can be null.

customFields · object

Show child attributes

isInternational · boolean

Whether the employee is an international employee or not.

isManager · boolean

Whether the employee is a manger

workSchedule · object

The employee's weekly work schedule

isRemote · boolean

Whether the employee's job is remote

employeeNumber · string

This indicates the sequential employee number within their company. This number continues to grow as each employee is onboarded. i.e if you are the 65th employee to join the company with 32 active employees, the employeeNumber would be 65.

level · string

The level of the employee

teams · any[]

An array of the teams that the employee is on

photo · string

The photo of the employee stored in Rippling

smallPhoto · string

The small photo of the employee stored in Rippling