Rippling: GET Employees — employee Api get Employees
Rippling employeeApi.getEmployees: arguments, response, policy and SDK examples.
← Employee API operations · Get started
Operation rippling.employee_api.get_employees
Provider route: GET /platform/api/employees. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["employeeApi"]["getEmployees"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.employeeApi.getEmployees(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_rippling import RipplingIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.employee_api.get_employees(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | |
query.offset | integer | Optional | |
query.countryCode | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand GET Employees — employee Api get Employees — response body |
Referenced models: GET Employees — employee Api get Employees — response body
Schemas
Section titled “Schemas”5 more schemas are linked from the tables above, on the schema pages.
GET Employees — employee Api get Employees — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An employee model object. |
address | JSON | Optional | |
address (anyOf 1) | object | Alternative | An address object as stored within Rippling. |
address (anyOf 1).city | string | Optional | |
address (anyOf 1).country | string | Optional | |
address (anyOf 1).state | string | Optional | |
address (anyOf 1).streetLine1 | string | Optional | |
address (anyOf 1).zip | string | Optional | |
address (anyOf 2) | null | Alternative | |
companyEmploymentType | Model | Optional | Expand GET Employees — employee Api get Employees — response body — company Employment Type |
compensation | Model | Optional | Expand GET Employees — employee Api get Employees — response body — compensation |
createdAt | string | Optional | When the row was created |
customFields | Model | Optional | Expand GET Custom Fields — response body — item |
department | string | Optional | The employee's department name |
departmentId | string | Optional | The unique identifier of the employee's department |
dob | string | Optional | Date of birth |
ein | string | Optional | The employee identifier number |
employeeNumber | JSON | Optional | |
employeeNumber (anyOf 1) | string | Alternative | The employee number |
employeeNumber (anyOf 2) | JSON | Alternative | |
employeeNumber (anyOf 2) (anyOf 1) | integer | Alternative | |
employeeNumber (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
employmentType | string | Optional | An ENUM of employment type. Will default to one of these six values unless the employee's profile has a job display name configured. Known values: CONTRACTOR, SALARIED_FT, SALARIED_PT, HOURLY_FT, HOURLY_PT, TEMP |
endDate | JSON | Optional | |
endDate (anyOf 1) | string | Alternative | The employee's end date. Will only return information after the employee's termination. |
endDate (anyOf 2) | null | Alternative | |
entityId | string | Optional | The legal entity ID the employee is employed on |
filingStatus | JSON | Optional | |
filingStatus (anyOf 1) | string | Alternative | An ENUM of Filing Status Known values: SINGLE, MARRIED, MARRIED_USER_SINGLE_RATE |
filingStatus (anyOf 2) | null | Alternative | |
firstName | string | Optional | First name of the employee |
flsaStatus | string | Optional | The employee's FLSA status stating whether they are exempt or non-exempt Known values: exempt, non-exempt |
gender | JSON | Optional | |
gender (anyOf 1) | string | Alternative | The employee's gender Known values: MALE, FEMALE |
gender (anyOf 2) | null | Alternative | |
hsaCompatiblePlanStatus | JSON | Optional | |
hsaCompatiblePlanStatus (anyOf 1) | object | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).annualLimit | JSON | Optional | |
hsaCompatiblePlanStatus (anyOf 1).annualLimit (anyOf 1) | string | Alternative | Known values: INDIVIDUAL, FAMILY, NULL |
hsaCompatiblePlanStatus (anyOf 1).annualLimit (anyOf 2) | null | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).effectiveDate | JSON | Optional | |
hsaCompatiblePlanStatus (anyOf 1).effectiveDate (anyOf 1) | string | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).effectiveDate (anyOf 2) | null | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).expirationDate | JSON | Optional | |
hsaCompatiblePlanStatus (anyOf 1).expirationDate (anyOf 1) | string | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).expirationDate (anyOf 2) | null | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).status | string | Optional | Known values: ENROLLED, NOT_ENROLLED, NOT_OFFERED, PENDING_ENROLLMENT |
hsaCompatiblePlanStatus (anyOf 2) | null | Alternative | |
id | string | Optional | This is the unique role ID of the employee. A role ID exists per 1 and only 1 company. |
identifiedGender | JSON | Optional | |
identifiedGender (anyOf 1) | string | Alternative | The employee's identified gender |
identifiedGender (anyOf 2) | null | Alternative | |
internationalBankAccount | JSON | Optional | |
internationalBankAccount (anyOf 1) | string | Alternative | The international bank account |
internationalBankAccount (anyOf 2) | null | Alternative | |
isInternational | boolean | Optional | Boolean for whether the employee outside the US |
isManager | boolean | Optional | Boolean for whether the employee is a manager |
isPeoEmployee | boolean | Optional | Boolean for whether the employee is under a PEO |
isRemote | boolean | Optional | If the employee is a remote worker or not |
lastName | string | Optional | Last name of the employee |
level | JSON | Optional | |
level (anyOf 1) | string | Alternative | The level of the employee |
level (anyOf 2) | null | Alternative | |
manager | JSON | Optional | |
manager (anyOf 1) | string | Alternative | The manager of the employee |
manager (anyOf 2) | null | Alternative | |
name | string | Optional | Full name of the employee |
offerAcceptedDate | string | Optional | The date the employee accepted the offer letter |
payScheduleId | string | Optional | The ID of the payschedule |
personalEmail | string | Optional | Personal Email |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Phone Number |
phone (anyOf 2) | null | Alternative | |
phoneNumber | JSON | Optional | |
phoneNumber (anyOf 1) | string | Alternative | Phone Number |
phoneNumber (anyOf 2) | null | Alternative | |
photo | JSON | Optional | |
photo (anyOf 1) | string | Alternative | |
photo (anyOf 2) | null | Alternative | |
preferredFirstName | string | Optional | |
preferredLastName | string | Optional | |
roleState | string | Optional | 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. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
smallPhoto | JSON | Optional | |
smallPhoto (anyOf 1) | string | Alternative | |
smallPhoto (anyOf 2) | null | Alternative | |
spokeId | JSON | Optional | |
spokeId (anyOf 1) | string | Alternative | |
spokeId (anyOf 2) | null | Alternative | |
ssn | JSON | Optional | |
ssn (anyOf 1) | string | Alternative | Social Security Number |
ssn (anyOf 2) | null | Alternative | |
startDate | string | Optional | The employee's start date on Rippling. |
teams | array | Optional | The teams the employee is on |
teams[] | JSON | Each item | |
terminationInfo | Model | Optional | Expand GET Employees — employee Api get Employees — response body — termination Info |
title | string | Optional | The employee's work title |
updatedAt | string | Optional | When the row was updated |
userId | JSON | Optional | |
userId (anyOf 1) | string | Alternative | This is the unique user ID of the employee. A userID can span across 1 or many companies. |
userId (anyOf 2) | null | Alternative | |
w2EndDate | JSON | Optional | |
w2EndDate (anyOf 1) | string | Alternative | The employee's end date as a W2 employee. |
w2EndDate (anyOf 2) | null | Alternative | |
w2StartDate | string | Optional | The employee's start date as a W2 employee. |
workEmail | JSON | Optional | |
workEmail (anyOf 1) | string | Alternative | The work email of the employee |
workEmail (anyOf 2) | null | Alternative | |
workLocation | JSON | Optional | |
workLocation (anyOf 1) | object | Alternative | An address object as stored within Rippling. |
workLocation (anyOf 1).city | string | Optional | |
workLocation (anyOf 1).country | string | Optional | |
workLocation (anyOf 1).state | string | Optional | |
workLocation (anyOf 1).streetLine1 | string | Optional | |
workLocation (anyOf 1).zip | string | Optional | |
workLocation (anyOf 2) | null | Alternative | |
workLocationId | string | Optional | The unique identifier of the employee's work location |
workLocationNickname | string | Optional | The nickname for the work location |
workSchedule | Model | Optional | Expand GET Employees — employee Api get Employees — response body — work Schedule |
Referenced models: GET Employees — employee Api get Employees — response body — company Employment Type, GET Custom Fields — response body — item, GET Employees — employee Api get Employees — response body — compensation, GET Employees — employee Api get Employees — response body — termination Info, GET Employees — employee Api get Employees — response body — work Schedule
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.employee_api.get_employees. Catalog operation: v1.get-employees. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.