Rippling: GET Employee — base Api get Employees Employee Id
Rippling baseApi.getEmployeesEmployeeId: arguments, response, policy and SDK examples.
← Base API operations · Get started
Operation rippling.base_api.get_employees_employeeid
Provider route: GET /platform/api/employees/{employeeId}. 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["baseApi"]["getEmployeesEmployeeId"]>[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.baseApi.getEmployeesEmployeeId(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.base_api.get_employees_employee_id(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.employeeId | string | Required within parent |
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 Employee — base Api get Employees Employee Id — response body |
Referenced models: GET Employee — base Api get Employees Employee Id — response body
Schemas
Section titled “Schemas”GET Employee — base Api get Employees Employee Id — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An employee model object. |
customFields | Model | Optional | Expand GET Employee — base Api get Employees Employee Id — response body — custom Fields |
department | string | Optional | The employee's department name |
employeeNumber | string | Optional | 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. |
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 |
endDate (anyOf 2) | null | Alternative | |
firstName | string | Optional | First name of the employee |
gender | JSON | Optional | |
gender (anyOf 1) | string | Alternative | The employee's gender Known values: MALE, FEMALE |
gender (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 Known values: MALE, FEMALE, NONBINARY |
identifiedGender (anyOf 2) | null | Alternative | |
isInternational | boolean | Optional | Whether the employee is an international employee or not. |
isManager | boolean | Optional | Whether the employee is a manger |
isRemote | boolean | Optional | Whether the employee's job is remote |
lastName | string | Optional | Last name of the employee |
level | string | Optional | The level of the employee |
manager | JSON | Optional | |
manager (anyOf 1) | string | Alternative | The unique identifier of the employee's manager. This value can be null. |
manager (anyOf 2) | null | Alternative | |
name | string | Optional | Full name of the employee |
photo | string | Optional | The photo of the employee stored in Rippling |
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 | string | Optional | The small photo of the employee stored in Rippling |
spokeId | JSON | Optional | |
spokeId (anyOf 1) | string | Alternative | |
spokeId (anyOf 2) | null | Alternative | |
teams | array | Optional | An array of the teams that the employee is on |
teams[] | JSON | Each item | |
title | string | Optional | The employee's work title |
userId | string | Optional | This is the unique user ID of the employee. A userID can span across 1 or many companies. |
workEmail | JSON | Optional | |
workEmail (anyOf 1) | string | Alternative | The employee's work email |
workEmail (anyOf 2) | null | Alternative | |
workLocation | JSON | Optional | |
workLocation (anyOf 1) | Model | Alternative | Expand GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling |
workLocation (anyOf 2) | null | Alternative | |
workSchedule | object | Optional | The employee's weekly work schedule |
worklocationNickname | string | Optional | The work location nickname |
Referenced models: GET Employee — base Api get Employees Employee Id — response body — custom Fields, GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling
GET Employee — base Api get Employees Employee Id — response body — custom Fields
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customFieldTitle1 | string | Optional | |
customFieldTitleN | string | Optional |
GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An address object as stored within Rippling. |
city | string | Optional | |
country | string | Optional | |
isRemote | boolean | Optional | |
phone | string | Optional | |
state | string | Optional | |
steLocationCode | object | Optional | |
steLocationCode.cityCode | string | Optional | |
steLocationCode.countyCode | string | Optional | |
steLocationCode.isOverridden | string | Optional | |
steLocationCode.locationCode | string | Optional | |
steLocationCode.municipalityCode | string | Optional | |
steLocationCode.psdCode | string | Optional | |
steLocationCode.schoolCode | string | Optional | |
steLocationCode.stateCode | string | Optional | |
steLocationCode.transitDistrictCode | string | Optional | |
streetLine1 | string | Optional | |
streetLine2 | string | Optional | |
zip | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.base_api.get_employees_employeeid. Catalog operation: v1.get-employees-employeeId. 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.