{ "components": { "schemas": { "OutputEmployeeApiCompanyEmploymentType4a950bc69184": { "description": "A company employment type model object.", "properties": { "company": { "type": "string" }, "country": { "type": "string" }, "createdAt": { "type": "string" }, "displayName": { "type": "string" }, "external_on_changes": { "anyOf": [ { "type": "string" }, { "items": {}, "type": "array" } ] }, "id": { "type": "string" }, "isContractor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "isEOR": { "type": "string" }, "isFullTime": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isHourly": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isPartTime": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSalaried": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isTemporary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "label": { "type": "string" }, "lock": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "possible_new_employment_types": { "items": {}, "type": "array" }, "updatedAt": { "type": "string" } }, "title": "companyEmploymentType", "type": "object" }, "OutputEmployeeApiCompanyEmploymentTypea852e00cb647": { "description": "A company employment type model object.", "properties": { "company": { "type": "string" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "displayName": { "type": "string" }, "external_on_changes": { "anyOf": [ { "type": "string" }, { "items": {}, "type": "array" } ] }, "id": { "type": "string" }, "isContractor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "isEOR": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isFullTime": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isHourly": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isPartTime": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSalaried": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isTemporary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "label": { "type": "string" }, "lock": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "possible_new_employment_types": { "items": {}, "type": "array" }, "updatedAt": { "type": "string" } }, "title": "companyEmploymentType", "type": "object" }, "OutputEmployeeApiCompensation5c2a878b7c2b": { "description": "A compensation package model object.", "properties": { "annualSalary": { "type": "string" }, "bonusPaymentDays": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bonusSchedule": { "type": "string" }, "currency": { "type": "string" }, "equityNumShares": { "anyOf": [ { "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "onTargetCommission": { "type": "string" }, "relocationReimbursement": { "type": "string" }, "salaryPerUnit": { "type": "string" }, "salaryUnit": {}, "signingBonus": { "type": "string" }, "targetAnnualBonus": { "type": "string" }, "targetAnnualBonusPercent": { "type": "string" } }, "title": "compensation", "type": "object" }, "OutputEmployeeApiCustomFieldsd692f39008c9": { "description": "A Custom Fields object within Rippling.", "properties": { "Id": { "description": "The identifier of the specific custom field.", "type": "string" }, "required": { "description": "Denotes whether the custom field is or is not mandatory", "type": "boolean" }, "title": { "description": "The title of the custom field.", "type": "string" }, "type": { "description": "Denotes the type of the custom field.", "type": "string" } }, "title": "customFields", "type": "object" }, "OutputEmployeeApiEmployee5e5bf638ab19": { "description": "An employee model object.", "properties": { "address": { "anyOf": [ { "description": "An address object as stored within Rippling.", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "streetLine1": { "type": "string" }, "zip": { "type": "string" } }, "title": "address", "type": "object" }, { "type": "null" } ] }, "companyEmploymentType": { "$ref": "#/components/schemas/OutputEmployeeApiCompanyEmploymentType4a950bc69184" }, "compensation": { "$ref": "#/components/schemas/OutputEmployeeApiCompensation5c2a878b7c2b" }, "createdAt": { "description": "When the row was created", "type": "string" }, "customFields": { "$ref": "#/components/schemas/OutputEmployeeApiCustomFieldsd692f39008c9" }, "department": { "description": "The employee's department name", "type": "string" }, "departmentId": { "description": "The unique identifier of the employee's department", "type": "string" }, "dob": { "description": "Date of birth", "type": "string" }, "ein": { "description": "The employee identifier number", "type": "string" }, "employeeNumber": { "anyOf": [ { "description": "The employee number", "type": "string" }, { "anyOf": [ { "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } ] }, "employmentType": { "description": "An ENUM of employment type. Will default to one of these six values unless the employee's profile has a job display name configured.", "type": "string" }, "endDate": { "anyOf": [ { "description": "The employee's end date. Will only return information after the employee's termination.", "type": "string" }, { "type": "null" } ] }, "entityId": { "description": "The legal entity ID the employee is employed on", "type": "string" }, "filingStatus": { "anyOf": [ { "description": "An ENUM of Filing Status", "type": "string" }, { "type": "null" } ] }, "firstName": { "description": "First name of the employee", "type": "string" }, "flsaStatus": { "description": "The employee's FLSA status stating whether they are exempt or non-exempt", "type": "string" }, "gender": { "anyOf": [ { "description": "The employee's gender", "type": "string" }, { "type": "null" } ] }, "hsaCompatiblePlanStatus": { "anyOf": [ { "properties": { "annualLimit": { "type": "string" }, "effectiveDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" } }, "title": "hsaCompatiblePlanStatus", "type": "object" }, { "type": "null" } ] }, "id": { "description": "This is the unique role ID of the employee. A role ID exists per 1 and only 1 company.", "type": "string" }, "identifiedGender": { "anyOf": [ { "description": "The employee's identified gender", "type": "string" }, { "type": "null" } ] }, "internationalBankAccount": { "anyOf": [ { "description": "The international bank account", "type": "string" }, { "type": "null" } ] }, "isInternational": { "description": "Boolean for whether the employee outside the US", "type": "boolean" }, "isManager": { "description": "Boolean for whether the employee is a manager", "type": "boolean" }, "isPeoEmployee": { "description": "Boolean for whether the employee is under a PEO", "type": "boolean" }, "isRemote": { "description": "If the employee is a remote worker or not", "type": "boolean" }, "lastName": { "description": "Last name of the employee", "type": "string" }, "level": { "anyOf": [ { "description": "The level of the employee", "type": "string" }, { "type": "null" } ] }, "manager": { "anyOf": [ { "description": "The manager of the employee", "type": "string" }, { "type": "null" } ] }, "name": { "description": "Full name of the employee", "type": "string" }, "offerAcceptedDate": { "description": "The date the employee accepted the offer letter", "type": "string" }, "payScheduleId": { "description": "The ID of the payschedule", "type": "string" }, "personalEmail": { "description": "Personal Email", "type": "string" }, "phone": { "anyOf": [ { "description": "Phone Number", "type": "string" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "description": "Phone Number", "type": "string" }, { "type": "null" } ] }, "photo": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "preferredFirstName": { "type": "string" }, "preferredLastName": { "type": "string" }, "roleState": { "description": "The employee's role status - roleState meanings:\n\nINIT: An initial record of an individual. An offer has not been made and they have not started working at the company.\n\nHIRED: An offer has been made but they have not accepted or started yet.\n\nACCEPTED: An offer has been made and they have accepted, but they have not started yet.\n\nACTIVE: The employee currently works at the company and their start date is today or in the past.\n\nTERMINATED: The employee is no longer active.", "type": "string" }, "smallPhoto": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "spokeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ssn": { "anyOf": [ { "description": "Social Security Number", "type": "string" }, { "type": "null" } ] }, "startDate": { "description": "The employee's start date on Rippling.", "type": "string" }, "teams": { "description": "The teams the employee is on", "items": {}, "type": "array" }, "terminationInfo": { "$ref": "#/components/schemas/OutputEmployeeApiTerminationInfod17b2dd590e4" }, "title": { "description": "The employee's work title", "type": "string" }, "updatedAt": { "description": "When the row was updated", "type": "string" }, "userId": { "anyOf": [ { "description": "This is the unique user ID of the employee. A userID can span across 1 or many companies.", "type": "string" }, { "type": "null" } ] }, "w2EndDate": { "anyOf": [ { "description": "The employee's end date as a W2 employee.", "type": "string" }, { "type": "null" } ] }, "w2StartDate": { "description": "The employee's start date as a W2 employee.", "type": "string" }, "workEmail": { "anyOf": [ { "description": "The work email of the employee", "type": "string" }, { "type": "null" } ] }, "workLocation": { "anyOf": [ { "description": "An address object as stored within Rippling.", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "streetLine1": { "type": "string" }, "zip": { "type": "string" } }, "title": "address", "type": "object" }, { "type": "null" } ] }, "workLocationId": { "description": "The unique identifier of the employee's work location", "type": "string" }, "workLocationNickname": { "description": "The nickname for the work location", "type": "string" }, "workSchedule": { "$ref": "#/components/schemas/OutputEmployeeApiWorkSchedulef48f47b2f333" } }, "title": "Employee", "type": "object" }, "OutputEmployeeApiEmployee70a2b243901d": { "description": "An employee model object.", "properties": { "address": { "anyOf": [ { "description": "An address object as stored within Rippling.", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "streetLine1": { "type": "string" }, "zip": { "type": "string" } }, "title": "address", "type": "object" }, { "type": "null" } ] }, "companyEmploymentType": { "$ref": "#/components/schemas/OutputEmployeeApiCompanyEmploymentTypea852e00cb647" }, "compensation": { "$ref": "#/components/schemas/OutputEmployeeApiCompensation5c2a878b7c2b" }, "createdAt": { "description": "When the row was created", "type": "string" }, "customFields": { "$ref": "#/components/schemas/OutputEmployeeApiCustomFieldsd692f39008c9" }, "department": { "description": "The employee's department name", "type": "string" }, "departmentId": { "description": "The unique identifier of the employee's department", "type": "string" }, "dob": { "description": "Date of birth", "type": "string" }, "ein": { "description": "The employee identifier number", "type": "string" }, "employeeNumber": { "anyOf": [ { "description": "The employee number", "type": "string" }, { "anyOf": [ { "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } ] }, "employmentType": { "description": "An ENUM of employment type. Will default to one of these six values unless the employee's profile has a job display name configured.", "type": "string" }, "endDate": { "anyOf": [ { "description": "The employee's end date. Will only return information after the employee's termination.", "type": "string" }, { "type": "null" } ] }, "entityId": { "description": "The legal entity ID the employee is employed on", "type": "string" }, "filingStatus": { "anyOf": [ { "description": "An ENUM of Filing Status", "type": "string" }, { "type": "null" } ] }, "firstName": { "description": "First name of the employee", "type": "string" }, "flsaStatus": { "description": "The employee's FLSA status stating whether they are exempt or non-exempt", "type": "string" }, "gender": { "anyOf": [ { "description": "The employee's gender", "type": "string" }, { "type": "null" } ] }, "hsaCompatiblePlanStatus": { "anyOf": [ { "properties": { "annualLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "effectiveDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" } }, "title": "hsaCompatiblePlanStatus", "type": "object" }, { "type": "null" } ] }, "id": { "description": "This is the unique role ID of the employee. A role ID exists per 1 and only 1 company.", "type": "string" }, "identifiedGender": { "anyOf": [ { "description": "The employee's identified gender", "type": "string" }, { "type": "null" } ] }, "internationalBankAccount": { "anyOf": [ { "description": "The international bank account", "type": "string" }, { "type": "null" } ] }, "isInternational": { "description": "Boolean for whether the employee outside the US", "type": "boolean" }, "isManager": { "description": "Boolean for whether the employee is a manager", "type": "boolean" }, "isPeoEmployee": { "description": "Boolean for whether the employee is under a PEO", "type": "boolean" }, "isRemote": { "description": "If the employee is a remote worker or not", "type": "boolean" }, "lastName": { "description": "Last name of the employee", "type": "string" }, "level": { "anyOf": [ { "description": "The level of the employee", "type": "string" }, { "type": "null" } ] }, "manager": { "anyOf": [ { "description": "The manager of the employee", "type": "string" }, { "type": "null" } ] }, "name": { "description": "Full name of the employee", "type": "string" }, "offerAcceptedDate": { "description": "The date the employee accepted the offer letter", "type": "string" }, "payScheduleId": { "description": "The ID of the payschedule", "type": "string" }, "personalEmail": { "description": "Personal Email", "type": "string" }, "phone": { "anyOf": [ { "description": "Phone Number", "type": "string" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "description": "Phone Number", "type": "string" }, { "type": "null" } ] }, "photo": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "preferredFirstName": { "type": "string" }, "preferredLastName": { "type": "string" }, "roleState": { "description": "The employee's role status - roleState meanings:\n\nINIT: An initial record of an individual. An offer has not been made and they have not started working at the company.\n\nHIRED: An offer has been made but they have not accepted or started yet.\n\nACCEPTED: An offer has been made and they have accepted, but they have not started yet.\n\nACTIVE: The employee currently works at the company and their start date is today or in the past.\n\nTERMINATED: The employee is no longer active.", "type": "string" }, "smallPhoto": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "spokeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ssn": { "anyOf": [ { "description": "Social Security Number", "type": "string" }, { "type": "null" } ] }, "startDate": { "description": "The employee's start date on Rippling.", "type": "string" }, "teams": { "description": "The teams the employee is on", "items": {}, "type": "array" }, "terminationInfo": { "$ref": "#/components/schemas/OutputEmployeeApiTerminationInfod17b2dd590e4" }, "title": { "description": "The employee's work title", "type": "string" }, "updatedAt": { "description": "When the row was updated", "type": "string" }, "userId": { "anyOf": [ { "description": "This is the unique user ID of the employee. A userID can span across 1 or many companies.", "type": "string" }, { "type": "null" } ] }, "w2EndDate": { "anyOf": [ { "description": "The employee's end date as a W2 employee.", "type": "string" }, { "type": "null" } ] }, "w2StartDate": { "description": "The employee's start date as a W2 employee.", "type": "string" }, "workEmail": { "anyOf": [ { "description": "The work email of the employee", "type": "string" }, { "type": "null" } ] }, "workLocation": { "anyOf": [ { "description": "An address object as stored within Rippling.", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "streetLine1": { "type": "string" }, "zip": { "type": "string" } }, "title": "address", "type": "object" }, { "type": "null" } ] }, "workLocationId": { "description": "The unique identifier of the employee's work location", "type": "string" }, "workLocationNickname": { "description": "The nickname for the work location", "type": "string" }, "workSchedule": { "$ref": "#/components/schemas/OutputEmployeeApiWorkSchedulebf12fc13b268" } }, "title": "Employee", "type": "object" }, "OutputEmployeeApiTerminationInfod17b2dd590e4": { "description": "A terminationInfo object within Rippling.", "properties": { "terminationReason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "terminationType": { "description": "The termination type indicates whether the termination was voluntary or involuntary." } }, "title": "terminationInfo", "type": "object" }, "OutputEmployeeApiWorkSchedulebf12fc13b268": { "description": "The set work schedule for the employee, as designated in their employee profile.", "properties": { "FRIDAY": { "properties": { "hours": { "type": "string" } }, "type": "object" }, "MONDAY": { "properties": { "hours": { "type": "string" } }, "type": "object" }, "SATURDAY": { "properties": { "hours": { "anyOf": [ { "type": "string" }, { "anyOf": [ { "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } ] } }, "type": "object" }, "SUNDAY": { "properties": { "hours": { "anyOf": [ { "type": "string" }, { "anyOf": [ { "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } ] } }, "type": "object" }, "THURSDAY": { "properties": { "hours": { "type": "string" } }, "type": "object" }, "TUESDAY": { "properties": { "hours": { "type": "string" } }, "type": "object" }, "WEDNESDAY": { "properties": { "hours": { "type": "string" } }, "type": "object" } }, "title": "workSchedule", "type": "object" }, "OutputEmployeeApiWorkSchedulef48f47b2f333": { "description": "The set work schedule for the employee, as designated in their employee profile.", "properties": { "FRIDAY": { "properties": { "hours": { "type": "string" } }, "type": "object" }, "MONDAY": { "properties": { "hours": { "type": "string" } }, "type": "object" }, "SATURDAY": { "properties": { "hours": { "type": "string" } }, "type": "object" }, "SUNDAY": { "properties": { "hours": { "type": "string" } }, "type": "object" }, "THURSDAY": { "properties": { "hours": { "type": "string" } }, "type": "object" }, "TUESDAY": { "properties": { "hours": { "type": "string" } }, "type": "object" }, "WEDNESDAY": { "properties": { "hours": { "type": "string" } }, "type": "object" } }, "title": "workSchedule", "type": "object" } } }, "info": { "title": "Rippling employee-api", "version": "2026-10-28" }, "openapi": "3.1.0", "paths": { "/platform/api/employees": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/employee-api/reference/get-employees" }, "operationId": "rippling.employee_api.get_employees", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "countryCode", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputEmployeeApiEmployee70a2b243901d" } } }, "description": "OK" } }, "servers": [ { "description": "production", "url": "https://api.rippling.com" }, { "description": "sandbox", "url": "https://api.ripplingpreview.com" } ], "summary": "GET Employees", "x-rippling-entitlements": [], "x-rippling-required-scopes": [] } }, "/platform/api/employees/include_terminated": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/employee-api/reference/get-employees-include-terminated" }, "operationId": "rippling.employee_api.get_employees_include_terminated", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "EIN", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "send_all_roles", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/OutputEmployeeApiEmployee5e5bf638ab19" }, "type": "array" } } }, "description": "OK" } }, "servers": [ { "description": "production", "url": "https://api.rippling.com" }, { "description": "sandbox", "url": "https://api.ripplingpreview.com" } ], "summary": "GET Employees (Including Terminated)", "x-rippling-entitlements": [], "x-rippling-required-scopes": [] } }, "/platform/api/employees/{employeeId}": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/employee-api/reference/get-employees-employee-id" }, "operationId": "rippling.employee_api.get_employees_employeeid", "parameters": [ { "in": "path", "name": "employeeId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputEmployeeApiEmployee5e5bf638ab19" } } }, "description": "OK" } }, "servers": [ { "description": "production", "url": "https://api.rippling.com" }, { "description": "sandbox", "url": "https://api.ripplingpreview.com" } ], "summary": "GET Employee", "x-rippling-entitlements": [], "x-rippling-required-scopes": [] }, "put": { "externalDocs": { "url": "https://developer.rippling.com/documentation/employee-api/reference/put-employees-employee-id" }, "operationId": "rippling.employee_api.put_employees_employeeid", "parameters": [ { "in": "path", "name": "employeeId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "customFields": { "properties": { "Field Name": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" } }, "servers": [ { "description": "production", "url": "https://api.rippling.com" }, { "description": "sandbox", "url": "https://api.ripplingpreview.com" } ], "summary": "PUT Employee", "x-rippling-entitlements": [], "x-rippling-required-scopes": [] } } } }