Skip to content

Rippling: Employee API schemas

8 Rippling schemas with complete fields and constraints.

← Employee API operations · All schemas

GET Employee — employee Api get Employees Employee Id — response body

FieldTypePresenceDescription and constraints
$objectRootAn employee model object.
addressJSONOptional
address (anyOf 1)objectAlternativeAn address object as stored within Rippling.
address (anyOf 1).citystringOptional
address (anyOf 1).countrystringOptional
address (anyOf 1).statestringOptional
address (anyOf 1).streetLine1stringOptional
address (anyOf 1).zipstringOptional
address (anyOf 2)nullAlternative
companyEmploymentTypeModelOptionalExpand GET Employee — employee Api get Employees Employee Id — response body — company Employment Type
compensationModelOptionalExpand GET Employees — employee Api get Employees — response body — compensation
createdAtstringOptionalWhen the row was created
customFieldsModelOptionalExpand GET Custom Fields — response body — item
departmentstringOptionalThe employee's department name
departmentIdstringOptionalThe unique identifier of the employee's department
dobstringOptionalDate of birth
einstringOptionalThe employee identifier number
employeeNumberJSONOptional
employeeNumber (anyOf 1)stringAlternativeThe employee number
employeeNumber (anyOf 2)JSONAlternative
employeeNumber (anyOf 2) (anyOf 1)integerAlternative
employeeNumber (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
employmentTypestringOptionalAn 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
endDateJSONOptional
endDate (anyOf 1)stringAlternativeThe employee's end date. Will only return information after the employee's termination.
endDate (anyOf 2)nullAlternative
entityIdstringOptionalThe legal entity ID the employee is employed on
filingStatusJSONOptional
filingStatus (anyOf 1)stringAlternativeAn ENUM of Filing Status
Known values: SINGLE, MARRIED, MARRIED_USER_SINGLE_RATE
filingStatus (anyOf 2)nullAlternative
firstNamestringOptionalFirst name of the employee
flsaStatusstringOptionalThe employee's FLSA status stating whether they are exempt or non-exempt
Known values: exempt, non-exempt
genderJSONOptional
gender (anyOf 1)stringAlternativeThe employee's gender
Known values: MALE, FEMALE
gender (anyOf 2)nullAlternative
hsaCompatiblePlanStatusJSONOptional
hsaCompatiblePlanStatus (anyOf 1)objectAlternative
hsaCompatiblePlanStatus (anyOf 1).annualLimitstringOptionalKnown values: INDIVIDUAL, FAMILY, NULL
hsaCompatiblePlanStatus (anyOf 1).effectiveDateJSONOptional
hsaCompatiblePlanStatus (anyOf 1).effectiveDate (anyOf 1)stringAlternative
hsaCompatiblePlanStatus (anyOf 1).effectiveDate (anyOf 2)nullAlternative
hsaCompatiblePlanStatus (anyOf 1).expirationDateJSONOptional
hsaCompatiblePlanStatus (anyOf 1).expirationDate (anyOf 1)stringAlternative
hsaCompatiblePlanStatus (anyOf 1).expirationDate (anyOf 2)nullAlternative
hsaCompatiblePlanStatus (anyOf 1).statusstringOptionalKnown values: ENROLLED, NOT_ENROLLED, NOT_OFFERED, PENDING_ENROLLMENT
hsaCompatiblePlanStatus (anyOf 2)nullAlternative
idstringOptionalThis is the unique role ID of the employee. A role ID exists per 1 and only 1 company.
identifiedGenderJSONOptional
identifiedGender (anyOf 1)stringAlternativeThe employee's identified gender
identifiedGender (anyOf 2)nullAlternative
internationalBankAccountJSONOptional
internationalBankAccount (anyOf 1)stringAlternativeThe international bank account
internationalBankAccount (anyOf 2)nullAlternative
isInternationalbooleanOptionalBoolean for whether the employee outside the US
isManagerbooleanOptionalBoolean for whether the employee is a manager
isPeoEmployeebooleanOptionalBoolean for whether the employee is under a PEO
isRemotebooleanOptionalIf the employee is a remote worker or not
lastNamestringOptionalLast name of the employee
levelJSONOptional
level (anyOf 1)stringAlternativeThe level of the employee
level (anyOf 2)nullAlternative
managerJSONOptional
manager (anyOf 1)stringAlternativeThe manager of the employee
manager (anyOf 2)nullAlternative
namestringOptionalFull name of the employee
offerAcceptedDatestringOptionalThe date the employee accepted the offer letter
payScheduleIdstringOptionalThe ID of the payschedule
personalEmailstringOptionalPersonal Email
phoneJSONOptional
phone (anyOf 1)stringAlternativePhone Number
phone (anyOf 2)nullAlternative
phoneNumberJSONOptional
phoneNumber (anyOf 1)stringAlternativePhone Number
phoneNumber (anyOf 2)nullAlternative
photoJSONOptional
photo (anyOf 1)stringAlternative
photo (anyOf 2)nullAlternative
preferredFirstNamestringOptional
preferredLastNamestringOptional
roleStatestringOptionalThe 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
smallPhotoJSONOptional
smallPhoto (anyOf 1)stringAlternative
smallPhoto (anyOf 2)nullAlternative
spokeIdJSONOptional
spokeId (anyOf 1)stringAlternative
spokeId (anyOf 2)nullAlternative
ssnJSONOptional
ssn (anyOf 1)stringAlternativeSocial Security Number
ssn (anyOf 2)nullAlternative
startDatestringOptionalThe employee's start date on Rippling.
teamsarrayOptionalThe teams the employee is on
teams[]JSONEach item
terminationInfoModelOptionalExpand GET Employees — employee Api get Employees — response body — termination Info
titlestringOptionalThe employee's work title
updatedAtstringOptionalWhen the row was updated
userIdJSONOptional
userId (anyOf 1)stringAlternativeThis is the unique user ID of the employee. A userID can span across 1 or many companies.
userId (anyOf 2)nullAlternative
w2EndDateJSONOptional
w2EndDate (anyOf 1)stringAlternativeThe employee's end date as a W2 employee.
w2EndDate (anyOf 2)nullAlternative
w2StartDatestringOptionalThe employee's start date as a W2 employee.
workEmailJSONOptional
workEmail (anyOf 1)stringAlternativeThe work email of the employee
workEmail (anyOf 2)nullAlternative
workLocationJSONOptional
workLocation (anyOf 1)objectAlternativeAn address object as stored within Rippling.
workLocation (anyOf 1).citystringOptional
workLocation (anyOf 1).countrystringOptional
workLocation (anyOf 1).statestringOptional
workLocation (anyOf 1).streetLine1stringOptional
workLocation (anyOf 1).zipstringOptional
workLocation (anyOf 2)nullAlternative
workLocationIdstringOptionalThe unique identifier of the employee's work location
workLocationNicknamestringOptionalThe nickname for the work location
workScheduleModelOptionalExpand GET Employee — employee Api get Employees Employee Id — response body — work Schedule

Referenced models: GET Employee — employee Api get Employees Employee Id — response body — company Employment Type, GET Employee — employee Api get Employees Employee Id — response body — work Schedule, 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 Employee — employee Api get Employees Employee Id — response body — company Employment Type

FieldTypePresenceDescription and constraints
$objectRootA company employment type model object.
companystringOptional
countrystringOptional
createdAtstringOptional
displayNamestringOptional
external_on_changesJSONOptional
external_on_changes (anyOf 1)stringAlternative
external_on_changes (anyOf 2)arrayAlternative
external_on_changes (anyOf 2)[]JSONEach item
idstringOptional
isContractorJSONOptional
isContractor (anyOf 1)booleanAlternative
isContractor (anyOf 2)nullAlternative
isDeletedbooleanOptional
isEORstringOptional
isFullTimeJSONOptional
isFullTime (anyOf 1)booleanAlternative
isFullTime (anyOf 2)nullAlternative
isHourlyJSONOptional
isHourly (anyOf 1)booleanAlternative
isHourly (anyOf 2)nullAlternative
isPartTimeJSONOptional
isPartTime (anyOf 1)booleanAlternative
isPartTime (anyOf 2)nullAlternative
isSalariedJSONOptional
isSalaried (anyOf 1)booleanAlternative
isSalaried (anyOf 2)nullAlternative
isTemporaryJSONOptional
isTemporary (anyOf 1)booleanAlternative
isTemporary (anyOf 2)nullAlternative
labelstringOptional
lockJSONOptional
lock (anyOf 1)stringAlternative
lock (anyOf 2)nullAlternative
possible_new_employment_typesarrayOptional
possible_new_employment_types[]JSONEach item
updatedAtstringOptional

GET Employee — employee Api get Employees Employee Id — response body — work Schedule

FieldTypePresenceDescription and constraints
$objectRootThe set work schedule for the employee, as designated in their employee profile.
FRIDAYobjectOptional
FRIDAY.hoursstringOptional
MONDAYobjectOptional
MONDAY.hoursstringOptional
SATURDAYobjectOptional
SATURDAY.hoursstringOptional
SUNDAYobjectOptional
SUNDAY.hoursstringOptional
THURSDAYobjectOptional
THURSDAY.hoursstringOptional
TUESDAYobjectOptional
TUESDAY.hoursstringOptional
WEDNESDAYobjectOptional
WEDNESDAY.hoursstringOptional

GET Employees — employee Api get Employees — response body

FieldTypePresenceDescription and constraints
$objectRootAn employee model object.
addressJSONOptional
address (anyOf 1)objectAlternativeAn address object as stored within Rippling.
address (anyOf 1).citystringOptional
address (anyOf 1).countrystringOptional
address (anyOf 1).statestringOptional
address (anyOf 1).streetLine1stringOptional
address (anyOf 1).zipstringOptional
address (anyOf 2)nullAlternative
companyEmploymentTypeModelOptionalExpand GET Employees — employee Api get Employees — response body — company Employment Type
compensationModelOptionalExpand GET Employees — employee Api get Employees — response body — compensation
createdAtstringOptionalWhen the row was created
customFieldsModelOptionalExpand GET Custom Fields — response body — item
departmentstringOptionalThe employee's department name
departmentIdstringOptionalThe unique identifier of the employee's department
dobstringOptionalDate of birth
einstringOptionalThe employee identifier number
employeeNumberJSONOptional
employeeNumber (anyOf 1)stringAlternativeThe employee number
employeeNumber (anyOf 2)JSONAlternative
employeeNumber (anyOf 2) (anyOf 1)integerAlternative
employeeNumber (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
employmentTypestringOptionalAn 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
endDateJSONOptional
endDate (anyOf 1)stringAlternativeThe employee's end date. Will only return information after the employee's termination.
endDate (anyOf 2)nullAlternative
entityIdstringOptionalThe legal entity ID the employee is employed on
filingStatusJSONOptional
filingStatus (anyOf 1)stringAlternativeAn ENUM of Filing Status
Known values: SINGLE, MARRIED, MARRIED_USER_SINGLE_RATE
filingStatus (anyOf 2)nullAlternative
firstNamestringOptionalFirst name of the employee
flsaStatusstringOptionalThe employee's FLSA status stating whether they are exempt or non-exempt
Known values: exempt, non-exempt
genderJSONOptional
gender (anyOf 1)stringAlternativeThe employee's gender
Known values: MALE, FEMALE
gender (anyOf 2)nullAlternative
hsaCompatiblePlanStatusJSONOptional
hsaCompatiblePlanStatus (anyOf 1)objectAlternative
hsaCompatiblePlanStatus (anyOf 1).annualLimitJSONOptional
hsaCompatiblePlanStatus (anyOf 1).annualLimit (anyOf 1)stringAlternativeKnown values: INDIVIDUAL, FAMILY, NULL
hsaCompatiblePlanStatus (anyOf 1).annualLimit (anyOf 2)nullAlternative
hsaCompatiblePlanStatus (anyOf 1).effectiveDateJSONOptional
hsaCompatiblePlanStatus (anyOf 1).effectiveDate (anyOf 1)stringAlternative
hsaCompatiblePlanStatus (anyOf 1).effectiveDate (anyOf 2)nullAlternative
hsaCompatiblePlanStatus (anyOf 1).expirationDateJSONOptional
hsaCompatiblePlanStatus (anyOf 1).expirationDate (anyOf 1)stringAlternative
hsaCompatiblePlanStatus (anyOf 1).expirationDate (anyOf 2)nullAlternative
hsaCompatiblePlanStatus (anyOf 1).statusstringOptionalKnown values: ENROLLED, NOT_ENROLLED, NOT_OFFERED, PENDING_ENROLLMENT
hsaCompatiblePlanStatus (anyOf 2)nullAlternative
idstringOptionalThis is the unique role ID of the employee. A role ID exists per 1 and only 1 company.
identifiedGenderJSONOptional
identifiedGender (anyOf 1)stringAlternativeThe employee's identified gender
identifiedGender (anyOf 2)nullAlternative
internationalBankAccountJSONOptional
internationalBankAccount (anyOf 1)stringAlternativeThe international bank account
internationalBankAccount (anyOf 2)nullAlternative
isInternationalbooleanOptionalBoolean for whether the employee outside the US
isManagerbooleanOptionalBoolean for whether the employee is a manager
isPeoEmployeebooleanOptionalBoolean for whether the employee is under a PEO
isRemotebooleanOptionalIf the employee is a remote worker or not
lastNamestringOptionalLast name of the employee
levelJSONOptional
level (anyOf 1)stringAlternativeThe level of the employee
level (anyOf 2)nullAlternative
managerJSONOptional
manager (anyOf 1)stringAlternativeThe manager of the employee
manager (anyOf 2)nullAlternative
namestringOptionalFull name of the employee
offerAcceptedDatestringOptionalThe date the employee accepted the offer letter
payScheduleIdstringOptionalThe ID of the payschedule
personalEmailstringOptionalPersonal Email
phoneJSONOptional
phone (anyOf 1)stringAlternativePhone Number
phone (anyOf 2)nullAlternative
phoneNumberJSONOptional
phoneNumber (anyOf 1)stringAlternativePhone Number
phoneNumber (anyOf 2)nullAlternative
photoJSONOptional
photo (anyOf 1)stringAlternative
photo (anyOf 2)nullAlternative
preferredFirstNamestringOptional
preferredLastNamestringOptional
roleStatestringOptionalThe 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
smallPhotoJSONOptional
smallPhoto (anyOf 1)stringAlternative
smallPhoto (anyOf 2)nullAlternative
spokeIdJSONOptional
spokeId (anyOf 1)stringAlternative
spokeId (anyOf 2)nullAlternative
ssnJSONOptional
ssn (anyOf 1)stringAlternativeSocial Security Number
ssn (anyOf 2)nullAlternative
startDatestringOptionalThe employee's start date on Rippling.
teamsarrayOptionalThe teams the employee is on
teams[]JSONEach item
terminationInfoModelOptionalExpand GET Employees — employee Api get Employees — response body — termination Info
titlestringOptionalThe employee's work title
updatedAtstringOptionalWhen the row was updated
userIdJSONOptional
userId (anyOf 1)stringAlternativeThis is the unique user ID of the employee. A userID can span across 1 or many companies.
userId (anyOf 2)nullAlternative
w2EndDateJSONOptional
w2EndDate (anyOf 1)stringAlternativeThe employee's end date as a W2 employee.
w2EndDate (anyOf 2)nullAlternative
w2StartDatestringOptionalThe employee's start date as a W2 employee.
workEmailJSONOptional
workEmail (anyOf 1)stringAlternativeThe work email of the employee
workEmail (anyOf 2)nullAlternative
workLocationJSONOptional
workLocation (anyOf 1)objectAlternativeAn address object as stored within Rippling.
workLocation (anyOf 1).citystringOptional
workLocation (anyOf 1).countrystringOptional
workLocation (anyOf 1).statestringOptional
workLocation (anyOf 1).streetLine1stringOptional
workLocation (anyOf 1).zipstringOptional
workLocation (anyOf 2)nullAlternative
workLocationIdstringOptionalThe unique identifier of the employee's work location
workLocationNicknamestringOptionalThe nickname for the work location
workScheduleModelOptionalExpand 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

GET Employees — employee Api get Employees — response body — company Employment Type

FieldTypePresenceDescription and constraints
$objectRootA company employment type model object.
companystringOptional
countryJSONOptional
country (anyOf 1)stringAlternative
country (anyOf 2)nullAlternative
createdAtstringOptional
displayNamestringOptional
external_on_changesJSONOptional
external_on_changes (anyOf 1)stringAlternative
external_on_changes (anyOf 2)arrayAlternative
external_on_changes (anyOf 2)[]JSONEach item
idstringOptional
isContractorJSONOptional
isContractor (anyOf 1)booleanAlternative
isContractor (anyOf 2)nullAlternative
isDeletedbooleanOptional
isEORJSONOptional
isEOR (anyOf 1)stringAlternative
isEOR (anyOf 2)nullAlternative
isFullTimeJSONOptional
isFullTime (anyOf 1)booleanAlternative
isFullTime (anyOf 2)nullAlternative
isHourlyJSONOptional
isHourly (anyOf 1)booleanAlternative
isHourly (anyOf 2)nullAlternative
isPartTimeJSONOptional
isPartTime (anyOf 1)booleanAlternative
isPartTime (anyOf 2)nullAlternative
isSalariedJSONOptional
isSalaried (anyOf 1)booleanAlternative
isSalaried (anyOf 2)nullAlternative
isTemporaryJSONOptional
isTemporary (anyOf 1)booleanAlternative
isTemporary (anyOf 2)nullAlternative
labelstringOptional
lockJSONOptional
lock (anyOf 1)stringAlternative
lock (anyOf 2)nullAlternative
possible_new_employment_typesarrayOptional
possible_new_employment_types[]JSONEach item
updatedAtstringOptional

GET Employees — employee Api get Employees — response body — compensation

FieldTypePresenceDescription and constraints
$objectRootA compensation package model object.
annualSalarystringOptional
bonusPaymentDaysJSONOptional
bonusPaymentDays (anyOf 1)stringAlternative
bonusPaymentDays (anyOf 2)nullAlternative
bonusSchedulestringOptional
currencystringOptional
equityNumSharesJSONOptional
equityNumShares (anyOf 1)integerAlternative
equityNumShares (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
onTargetCommissionstringOptional
relocationReimbursementstringOptional
salaryPerUnitstringOptional
salaryUnitJSONOptionalKnown values: HOUR, DAY, WEEK, MONTH, YEAR, PAY_PERIOD
signingBonusstringOptional
targetAnnualBonusstringOptional
targetAnnualBonusPercentstringOptional

GET Employees — employee Api get Employees — response body — termination Info

FieldTypePresenceDescription and constraints
$objectRootA terminationInfo object within Rippling.
terminationReasonstringOptionalThis is a description that will be custom to each Rippling company.
terminationTypeJSONOptionalThe termination type indicates whether the termination was voluntary or involuntary.
Known values: VOLUNTARY, INVOLUNTARY

GET Employees — employee Api get Employees — response body — work Schedule

FieldTypePresenceDescription and constraints
$objectRootThe set work schedule for the employee, as designated in their employee profile.
FRIDAYobjectOptional
FRIDAY.hoursstringOptional
MONDAYobjectOptional
MONDAY.hoursstringOptional
SATURDAYobjectOptional
SATURDAY.hoursJSONOptional
SATURDAY.hours (anyOf 1)stringAlternative
SATURDAY.hours (anyOf 2)JSONAlternative
SATURDAY.hours (anyOf 2) (anyOf 1)numberAlternative
SATURDAY.hours (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
SUNDAYobjectOptional
SUNDAY.hoursJSONOptional
SUNDAY.hours (anyOf 1)stringAlternative
SUNDAY.hours (anyOf 2)JSONAlternative
SUNDAY.hours (anyOf 2) (anyOf 1)numberAlternative
SUNDAY.hours (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
THURSDAYobjectOptional
THURSDAY.hoursstringOptional
TUESDAYobjectOptional
TUESDAY.hoursstringOptional
WEDNESDAYobjectOptional
WEDNESDAY.hoursstringOptional

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.