Skip to content

Rippling: Base API schemas

21 Rippling schemas with complete fields and constraints.

← Base API operations · All schemas

GET Company Activity — base Api get Company Activity — response body — data events, next events array item

FieldTypePresenceDescription and constraints
$objectRootThe event model for company activity.

Please note, the event type can be one of the following:

- EXTERNAL_ACCONT_CREATE
- EXTERNAL_ACCOUNT_INVITE
- EXTERNAL_ACCOUNT_DELETE
- EXTERNAL_ACCOUNT_SUSPEND
- EXTERNAL_ACCOUNT_PASSWORD_RESET
- EXTERNAL_GROUP_ADD
- EXTERNAL_GROUP_REMOVE
- EXTERNAL_GROUP_MEMBER_REMOVE
- EXTERNAL_GROUP_MEMBER_ADD
- EXTERNAL_SSO_GRANT
- EXTERNAL_SSO_REVOKE
- EXTERNAL_SSO_SIGNIN
- RPASS_ITEM_SHARED
- RPASS_ITEM_UNSHARED
- RPASS_ITEM_USED
- USER_LOGIN_SUCCESS
- USER_LOGIN_FAILED
- ACCOUNT_PASSWORD_RESET
- ACCOUNT_PASSWORD_CHANGED
- TWO_FACTOR_DEVICE_RESET
companystringOptionalUnique identifier for the company.
event_reasonJSONOptional
event_reason (anyOf 1)objectAlternativeReason for the event, tied to the type of eveent.
event_reason (anyOf 1).messagestringOptionalMessage of the event.
event_reason (anyOf 1).reasonstringOptionalReason for the event.
event_reason (anyOf 2)nullAlternative
event_typestringOptionalAn ENUM value for the type of the event.
Known values: EXTERNAL_ACCOUNT_CREATE, EXTERNAL_ACCOUNT_INVITE, EXTERNAL_ACCOUNT_DELETE, EXTERNAL_ACCOUNT_SUSPEND, EXTERNAL_ACCOUNT_PASSWORD_RESET, EXTERNAL_GROUP_ADD, EXTERNAL_GROUP_REMOVE, EXTERNAL_GROUP_MEMBER_REMOVE, EXTERNAL_GROUP_MEMBER_ADD, EXTERNAL_SSO_GRANT, EXTERNAL_SSO_REVOKE, EXTERNAL_SSO_SIGNIN, EXTERNAL_SSO_SIGNIN_BLOCKED, RPASS_ITEM_SHARED, RPASS_ITEM_UNSHARED, RPASS_ITEM_USED, RPASS_FOLDER_SHARED, RPASS_FOLDER_UNSHARED, USER_LOGIN_SUCCESS, USER_LOGIN_FAILED, LDAP_AUTHENTICATION_SUCCESS, LDAP_AUTHENTICATION_FAILED, DEVICE_AUTHENTICATION_SUCCESS, DEVICE_AUTHENTICATION_FAILED, ACCOUNT_PASSWORD_RESET, ACCOUNT_PASSWORD_CHANGED, TWO_FACTOR_CHECK_SUCCESS, TWO_FACTOR_CHECK_FAILED, TWO_FACTOR_DEVICE_RESET, SPOKE_USER_MATCHED, SPOKE_USER_UNMATCHED, SECURITY_ADMINS_UPDATED, BDR_POLICY_UPDATED, AUTH_RULE_UPDATED, COMPANY_AUTH_RULE_UPDATED, ACCESS_TOKEN_EXPIRED, INBOUND_SSO_SIGN_IN, SP_INIT_SIGN_IN, EMAIL_VERIFICATION_INITIATED, PHONE_VERIFICATION_INITIATED, EMAIL_VERIFICATION_SUCCEEDED, PHONE_VERIFICATION_SUCCEEDED, EMAIL_VERIFICATION_FAILED, PHONE_VERIFICATION_FAILED, GROUP_ACCESS_CHANGED, ROLE_ATTRIBUTE_CHANGED, SCHEDULED_CHANGE_CREATED, BEHAVIOUR_DETECTION_TEST, RULE_CHANGED, ADDED_TO_INCLUSION, REMOVED_FROM_INCLUSION, ADDED_TO_POST_ROLE_STATE_INCLUSION, REMOVED_FROM_POST_ROLE_STATE_INCLUSION, ADDED_TO_TERMINATED_INCLUSION, REMOVED_FROM_TERMINATED_INCLUSION, ADDED_TO_EXCLUSION, REMOVED_FROM_EXCLUSION, EXCLUSION_RULE_CHANGED, ROLE_STATE_CHANGED, MANAGER_CHANGED, DEPARTMENT_CHANGED, LEVEL_CHANGED, ADDED_TO_TEAM, REMOVED_FROM_TEAM, JOB_UPDATED, LOCATION_CHANGED, EMPLOYMENT_TYPE_CHANGED
idstringOptionalUnique identifier of the event.
initiatorJSONOptional
initiator (anyOf 1)ModelAlternativeExpand GET Company Activity — baseApi.getCompanyActivity — response body — data / events, next / events / array / item / initiator / type: ROLE, SYSTEM, EXTERNAL
initiator (anyOf 2)nullAlternative
linked_eventsarrayOptionalAn array of event identifiers that are linked to the event.
linked_events[]stringEach item
namestringOptionalDisplay name for the event, tied to the type of event.
request_dataJSONOptional
request_data (anyOf 1)ModelAlternativeExpand GET Company Activity — base Api get Company Activity — response body — data events, next events array item request data city, country, ip, latitude, longitude
request_data (anyOf 2)nullAlternative
spokeJSONOptional
spoke (anyOf 1)stringAlternativeUnique identifier for the external application for which the event was recorded. This will be Null for events that don't correspond to an external appliction (e.g. Rippling system and RPass events).
spoke (anyOf 2)nullAlternative
subjectsarrayOptionalThe list of objects of the event.
subjects[]JSONEach item
subjects[] (anyOf 1)objectAlternative
subjects[] (anyOf 1).display_namestringOptionalName used within Rippling.
subjects[] (anyOf 1).iconJSONOptional
subjects[] (anyOf 1).icon (anyOf 1)stringAlternativeIcon used within Rippling.
subjects[] (anyOf 1).icon (anyOf 2)nullAlternative
subjects[] (anyOf 1).instancestringOptionalUnique key for the event object.
subjects[] (anyOf 1).typestringOptionalAn ENUM value for the type of object.
Known values: ROLE, SPOKE, RPASS_ITEM, SPOKE_USER, GROUP
subjects[] (anyOf 2)nullAlternative
timestampstringOptionalTimestamp at which the event was recorded.

Referenced models: GET Company Activity — baseApi.getCompanyActivity — response body — data / events, next / events / array / item / initiator / type: ROLE, SYSTEM, EXTERNAL, GET Company Activity — base Api get Company Activity — response body — data events, next events array item request data city, country, ip, latitude, longitude

GET Company Activity — base Api get Company Activity — response body — data events, next events array item request data city, country, ip, latitude, longitude

FieldTypePresenceDescription and constraints
$objectRootGeographic details from where the event was recorded.
citystringOptionalCity the event was triggered from.
countrystringOptionalCountry the event was triggered from.
ipstringOptionalEvent IP addresss.
latitudestringOptionalLatitude the event was triggered from.
longitudestringOptionalLongitude the event was triggered from.

GET Company Activity — baseApi.getCompanyActivity — response body — data / events, next / events / array / item / initiator / type: ROLE, SYSTEM, EXTERNAL

FieldTypePresenceDescription and constraints
$objectRootThe actor of the event.
display_namestringOptionalThe name used within Rippling.
iconJSONOptional
icon (anyOf 1)stringAlternativeThe icon used within Rippling.
icon (anyOf 2)nullAlternative
roleJSONOptional
role (anyOf 1)stringAlternativeA unique identifier for the employee that initiated the action, if the type is ROLE.
role (anyOf 2)nullAlternative
typestringOptionalENUM value for the type of actor.
Known values: ROLE, SYSTEM, EXTERNAL

GET Company Leave Types — response body — item

FieldTypePresenceDescription and constraints
$objectRootCompany leave request object
descriptionstringOptional
idstringOptionalUnique identifier of the company leave request
isUnpaidbooleanOptionalIs leave type unpaid
leaveTypestringOptionalCompany leave type key
namestringOptionalCompany leave type name

GET Current Company — base Api get Companies — response body

FieldTypePresenceDescription and constraints
$objectRootA company object as represented within Rippling.
addressJSONOptional
address (anyOf 1)ModelAlternativeExpand GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling
address (anyOf 2)nullAlternative
entitiesModelOptionalExpand GET Current Company — base Api get Companies — response body — entities
idstringOptional
namestringOptional
phonestringOptional
primaryEmailstringOptional
workLocationsarrayOptional
workLocations[]ModelEach itemExpand GET Work Locations — response body — item

Referenced models: GET Current Company — base Api get Companies — response body — entities, GET Work Locations — response body — item, GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling

GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling

FieldTypePresenceDescription and constraints
$objectRootAn address object as stored within Rippling.
citystringOptional
countrystringOptional
isRemotebooleanOptional
phonestringOptional
statestringOptional
steLocationCodeobjectOptional
steLocationCode.cityCodestringOptional
steLocationCode.countyCodestringOptional
steLocationCode.isOverriddenstringOptional
steLocationCode.locationCodestringOptional
steLocationCode.municipalityCodestringOptional
steLocationCode.psdCodestringOptional
steLocationCode.schoolCodestringOptional
steLocationCode.stateCodestringOptional
steLocationCode.transitDistrictCodestringOptional
streetLine1stringOptional
streetLine2stringOptional
zipstringOptional

GET Current Company — base Api get Companies — response body — entities

FieldTypePresenceDescription and constraints
$objectRootThis model represents the legal entities inside of a given company. Legal entities based in Canada (CA) are currently supported at this time.
CAarrayOptionalCA represents Canada.
CA[]objectEach item
CA[].entityInfoobjectOptional
CA[].entityInfo.businessNumberstringOptionalThe Canada Business Number
CA[].entityInfo.legalNamestringOptionalThe legal name of the entity
CA[].idstringOptionalThe unique Rippling ID of the legal entity
CA[].isEorbooleanOptionalIf set to true, the legal entity is Rippling's EOR. If set to false, the legal entity is not on Rippling's EOR.

GET Current User — response body

FieldTypePresenceDescription and constraints
$objectRootInformation about the Rippling user whose token is being used to access Rippling's API.
companystringOptionalUnique identifier of the company.
idstringOptionalUnied identifier of the user (likely an admin).
workEmailstringOptionalWork email of the user.

GET Custom Fields — response body — item

FieldTypePresenceDescription and constraints
$objectRootA Custom Fields object within Rippling.
IdstringOptionalThe identifier of the specific custom field.
requiredbooleanOptionalDenotes whether the custom field is or is not mandatory
titlestringOptionalThe title of the custom field.
typestringOptionalDenotes the type of the custom field.
Known values: TEXT, DATE, NUMBER, CURRENCY, PERCENTAGE, SELECT, FILE, ID, RADIO, TEXTAREA

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

FieldTypePresenceDescription and constraints
$objectRootAn employee model object.
customFieldsModelOptionalExpand GET Employee — base Api get Employees Employee Id — response body — custom Fields
departmentstringOptionalThe employee's department name
employeeNumberstringOptionalThis 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.
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
endDate (anyOf 2)nullAlternative
firstNamestringOptionalFirst name of the employee
genderJSONOptional
gender (anyOf 1)stringAlternativeThe employee's gender
Known values: MALE, FEMALE
gender (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
Known values: MALE, FEMALE, NONBINARY
identifiedGender (anyOf 2)nullAlternative
isInternationalbooleanOptionalWhether the employee is an international employee or not.
isManagerbooleanOptionalWhether the employee is a manger
isRemotebooleanOptionalWhether the employee's job is remote
lastNamestringOptionalLast name of the employee
levelstringOptionalThe level of the employee
managerJSONOptional
manager (anyOf 1)stringAlternativeThe unique identifier of the employee's manager. This value can be null.
manager (anyOf 2)nullAlternative
namestringOptionalFull name of the employee
photostringOptionalThe photo of the employee stored in Rippling
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
smallPhotostringOptionalThe small photo of the employee stored in Rippling
spokeIdJSONOptional
spokeId (anyOf 1)stringAlternative
spokeId (anyOf 2)nullAlternative
teamsarrayOptionalAn array of the teams that the employee is on
teams[]JSONEach item
titlestringOptionalThe employee's work title
userIdstringOptionalThis is the unique user ID of the employee. A userID can span across 1 or many companies.
workEmailJSONOptional
workEmail (anyOf 1)stringAlternativeThe employee's work email
workEmail (anyOf 2)nullAlternative
workLocationJSONOptional
workLocation (anyOf 1)ModelAlternativeExpand GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling
workLocation (anyOf 2)nullAlternative
workScheduleobjectOptionalThe employee's weekly work schedule
worklocationNicknamestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
customFieldTitle1stringOptional
customFieldTitleNstringOptional

GET Group — request body — body

FieldTypePresenceDescription and constraints
$objectRootThis payload should be used when updating existing groups.
namestringOptionalThe name of the Group.
spokeIdstringOptionalThe external identifier of the Group.
usersarrayOptionalThe array of users within the Group.
users[]JSONEach item
versionstringOptionalThe version identifier of the Group.

GET Group — response body

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptional
namestringOptionalUser-readable name of a Rippling group.
spokeIdJSONOptional
spokeId (anyOf 1)stringAlternativeYour id for the group; this should a unique string identifier.
spokeId (anyOf 2)nullAlternative
usersarrayOptionalAn array of employee Rippling ids.
users[]stringEach item
versionstringOptionalThe version unique identifier of the group.

GET Leave Balance — response body — balances Leave balances object

FieldTypePresenceDescription and constraints
$objectRootLeave balances object
stringOptional
balanceWithFutureRequestsJSONOptional
balanceWithFutureRequests (anyOf 1)numberAlternativeThe remaining balance in minutes for the employee corresponding to the company leave type with future leave requests considered.
balanceWithFutureRequests (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
balanceWithoutFutureRequestsJSONOptional
balanceWithoutFutureRequests (anyOf 1)numberAlternativeThe remaining balance in minutes for the employee corresponding to the company leave type with future leave requests not considered.
balanceWithoutFutureRequests (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
companyLeaveTypestringOptionalThis is the unique role ID of the company leave types. Corresponds to the ids in response of GET Company Leave Types
isBalanceUnlimitedbooleanOptionaltrue if employee's balance corresponding to the company leave type is unlimited, else false

GET Leave Requests — response body — item

FieldTypePresenceDescription and constraints
$objectRootLeave request object.
commentsJSONOptional
comments (anyOf 1)stringAlternative
comments (anyOf 2)nullAlternative
createdAtstringOptional
datesarrayOptional
dates[]objectEach item
dates[].datestringOptionalFormat: date
dates[].numMinutesJSONOptional
dates[].numMinutes (anyOf 1)integerAlternative
dates[].numMinutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endDatestringOptional
endDateCustomHoursJSONOptional
endDateCustomHours (anyOf 1)JSONAlternative
endDateCustomHours (anyOf 1) (anyOf 1)stringAlternative
endDateCustomHours (anyOf 1) (anyOf 2)nullAlternative
endDateCustomHours (anyOf 2)JSONAlternative
endDateCustomHours (anyOf 2) (anyOf 1)numberAlternative
endDateCustomHours (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endDateEndTimeJSONOptional
endDateEndTime (anyOf 1)stringAlternative
endDateEndTime (anyOf 2)nullAlternative
idstringOptionalUnique identifier of the leave request.
isPaidbooleanOptionalIf the leave request is paid this will be TRUE. Otherwise, this will be FALSE.
leavePolicystringOptional
leaveTypeUniqueIdstringOptionalKnown values: VACATION, SICK, JURY_DUTY
managedBystringOptionalThis indicates the system that manages the Leave Request. PTO = managed by Rippling's Time Off app. LEAVES = managed by Rippling's Leave Management app. TILT = managed by third-party partner Tilt.
Known values: PTO, LEAVES, TILT
numHoursJSONOptional
numHours (anyOf 1)JSONAlternative
numHours (anyOf 1) (anyOf 1)integerAlternative
numHours (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
numHours (anyOf 2)nullAlternative
numMinutesJSONOptional
numMinutes (anyOf 1)JSONAlternative
numMinutes (anyOf 1) (anyOf 1)integerAlternative
numMinutes (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
numMinutes (anyOf 2)nullAlternative
partialDaysarrayOptional
partialDays[]JSONEach item
partialDays[] (anyOf 1)objectAlternative
partialDays[] (anyOf 1).numMinutesJSONOptional
partialDays[] (anyOf 1).numMinutes (anyOf 1)integerAlternative
partialDays[] (anyOf 1).numMinutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
partialDays[] (anyOf 1).partialDaystringOptionalFormat: date
partialDays[] (anyOf 2)nullAlternative
policyDisplayNamestringOptional
processedAtJSONOptional
processedAt (anyOf 1)stringAlternative
processedAt (anyOf 2)nullAlternative
processedByJSONOptional
processedBy (anyOf 1)stringAlternativeUnique identifier of the employee who approved or rejected the request. This may be null.
processedBy (anyOf 2)nullAlternative
processedByNameJSONOptional
processedByName (anyOf 1)stringAlternative
processedByName (anyOf 2)nullAlternative
reasonForLeaveJSONOptional
reasonForLeave (anyOf 1)stringAlternative
reasonForLeave (anyOf 2)nullAlternative
requestedByJSONOptional
requestedBy (anyOf 1)stringAlternative
requestedBy (anyOf 2)nullAlternative
requestedByNameJSONOptional
requestedByName (anyOf 1)stringAlternativeUnique identifier of the employee who made the request (in most cases this is the same as role).
requestedByName (anyOf 2)nullAlternative
rolestringOptionalUnique identifier of the employee who is taking leave.
roleNamestringOptional
roleTimezoneJSONOptional
roleTimezone (anyOf 1)stringAlternativeTimezone of the role. This will be work location timezone, or home timezone for employees without a work location.
roleTimezone (anyOf 2)nullAlternative
startDatestringOptional
startDateCustomHoursJSONOptional
startDateCustomHours (anyOf 1)JSONAlternative
startDateCustomHours (anyOf 1) (anyOf 1)stringAlternative
startDateCustomHours (anyOf 1) (anyOf 2)nullAlternative
startDateCustomHours (anyOf 2)JSONAlternative
startDateCustomHours (anyOf 2) (anyOf 1)numberAlternative
startDateCustomHours (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startDateStartTimeJSONOptional
startDateStartTime (anyOf 1)stringAlternative
startDateStartTime (anyOf 2)nullAlternative
statusstringOptionalKnown values: PENDING, APPROVED, REJECTED, CANCELED
updatedAtstringOptional

GET Levels — response body — item

FieldTypePresenceDescription and constraints
$objectRootLevels enable for self-defined,company-wide position levels, such as Manager, Engineering Manager, Executive, etc.
idstringOptionalUnique identifier of the level.
namestringOptionalName of the level.
parentJSONOptional
parent (anyOf 1)stringAlternativeThe unique identifier of the parent level.
parent (anyOf 2)nullAlternative

GET Teams — response body — item

FieldTypePresenceDescription and constraints
$objectRootA team is a self-defined group of employees within Rippling.
idstringOptionalThe identifier of the team.
namestringOptionalThe name of the team.
parentJSONOptional
parent (anyOf 1)stringAlternativeThe parent team (if this team is a subteam within a larger team).
parent (anyOf 2)nullAlternative

GET Work Locations — response body — item

FieldTypePresenceDescription and constraints
$objectRootA work location object.
addressJSONOptional
address (anyOf 1)ModelAlternativeExpand GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling
address (anyOf 2)nullAlternative
idstringOptional
nicknamestringOptional

Referenced models: GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling

POST Cancel Leave Request — response body

FieldTypePresenceDescription and constraints
$objectRootLeave request object.
commentsJSONOptional
comments (anyOf 1)stringAlternative
comments (anyOf 2)nullAlternative
createdAtstringOptional
datesarrayOptional
dates[]objectEach item
dates[].datestringOptionalFormat: date
dates[].numMinutesJSONOptional
dates[].numMinutes (anyOf 1)integerAlternative
dates[].numMinutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endDatestringOptional
endDateCustomHoursJSONOptional
endDateCustomHours (anyOf 1)stringAlternative
endDateCustomHours (anyOf 2)nullAlternative
endDateEndTimeJSONOptional
endDateEndTime (anyOf 1)stringAlternative
endDateEndTime (anyOf 2)nullAlternative
idstringOptionalUnique identifier of the leave request.
isPaidbooleanOptionalIf the leave request is paid this will be TRUE. Otherwise, this will be FALSE.
leavePolicystringOptional
leaveTypeUniqueIdstringOptionalKnown values: VACATION, SICK, JURY_DUTY
managedBystringOptionalThis indicates the system that manages the Leave Request. PTO = managed by Rippling's Time Off app. LEAVES = managed by Rippling's Leave Management app. TILT = managed by third-party partner Tilt.
Known values: PTO, LEAVES, TILT
numHoursJSONOptional
numHours (anyOf 1)JSONAlternative
numHours (anyOf 1) (anyOf 1)integerAlternative
numHours (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
numHours (anyOf 2)nullAlternative
numMinutesJSONOptional
numMinutes (anyOf 1)JSONAlternative
numMinutes (anyOf 1) (anyOf 1)integerAlternative
numMinutes (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
numMinutes (anyOf 2)nullAlternative
partialDaysarrayOptional
partialDays[]JSONEach item
partialDays[] (anyOf 1)objectAlternative
partialDays[] (anyOf 1).numMinutesJSONOptional
partialDays[] (anyOf 1).numMinutes (anyOf 1)integerAlternative
partialDays[] (anyOf 1).numMinutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
partialDays[] (anyOf 1).partialDaystringOptionalFormat: date
partialDays[] (anyOf 2)nullAlternative
policyDisplayNamestringOptional
processedAtJSONOptional
processedAt (anyOf 1)stringAlternative
processedAt (anyOf 2)nullAlternative
processedByJSONOptional
processedBy (anyOf 1)stringAlternativeUnique identifier of the employee who approved or rejected the request. This may be null.
processedBy (anyOf 2)nullAlternative
processedByNameJSONOptional
processedByName (anyOf 1)stringAlternative
processedByName (anyOf 2)nullAlternative
reasonForLeaveJSONOptional
reasonForLeave (anyOf 1)stringAlternative
reasonForLeave (anyOf 2)nullAlternative
requestedByJSONOptional
requestedBy (anyOf 1)stringAlternative
requestedBy (anyOf 2)nullAlternative
requestedByNameJSONOptional
requestedByName (anyOf 1)stringAlternativeUnique identifier of the employee who made the request (in most cases this is the same as role).
requestedByName (anyOf 2)nullAlternative
rolestringOptionalUnique identifier of the employee who is taking leave.
roleNamestringOptional
roleTimezoneJSONOptional
roleTimezone (anyOf 1)stringAlternativeTimezone of the role. This will be work location timezone, or home timezone for employees without a work location.
roleTimezone (anyOf 2)nullAlternative
startDatestringOptional
startDateCustomHoursJSONOptional
startDateCustomHours (anyOf 1)stringAlternative
startDateCustomHours (anyOf 2)nullAlternative
startDateStartTimeJSONOptional
startDateStartTime (anyOf 1)stringAlternative
startDateStartTime (anyOf 2)nullAlternative
statusstringOptionalKnown values: PENDING, APPROVED, REJECTED, CANCELED
updatedAtstringOptional

POST New Candidate — request body — body

FieldTypePresenceDescription and constraints
$objectRootThe Rippling candidate model.
attachmentsarrayOptional
attachments[]objectEach itemAn array of json objects containing file names and public file URLs containing documents pertaining to the candidate.
attachments[].file_namestringOptionalThe file name.
attachments[].file_urlstringOptionalThe public URL and name of a pdf/docx/doc/odt file containing documents pertaining to the candidate.
candidateIdstringOptionalThe unique identifier of the candidate from the ATS.
currencystringOptionalA string field of the official currency as listed in ISO 4217.
departmentstringOptionalThis is the id of the department from GET/departments.
emailstringOptionalThe candidate's email.
employmentTypestringOptionalAn ENUM of employment type. Will default to one of these six values unless the employee's profile has a job display name configured.
One of: CONTRACTOR, SALARIED_PT, SALARIED_FT, HOURLY_FT, HOURLY_PT, TEMP
equitySharesintegerOptionalThe number of shares that will be given to the candidate.
jobTitlestringOptionalThe candidate's job title.
namestringOptionalThe candidate's name.
phoneNumberstringOptionalThe candidate's phone number.
salaryPerUnitnumberOptionalThe decimal value that the candidate gets paid every salaryUnit time period.
salaryUnitstringOptionalAn ENUM string value, denoting the frequency at which the candidate should be paid once the role begins. Note, the PAY_PERIOD ENUM implies the candidate is paid as per a custom pay period.
One of: HOUR, DAY, WEEK, MONTH, PAY_PERIOD
signingBonusnumberOptionalThe bonus cash given to the candidate as a part of a one time payment, with two decimal digit precision.
Format: double
startDatestringOptionalThe would-be start date of the candidate.
Format: date
workLocationstringOptionalThis is the id of the worklocation from GET/work_locations.

POST New Candidate — response body

FieldTypePresenceDescription and constraints
$objectRootThe Rippling candidate model.
attachmentsarrayOptional
attachments[]objectEach itemAn array of json objects containing file names and public file URLs containing documents pertaining to the candidate.
attachments[].file_namestringOptionalThe file name.
attachments[].file_urlstringOptionalThe public URL and name of a pdf/docx/doc/odt file containing documents pertaining to the candidate.
candidateIdstringOptionalThe unique identifier of the candidate from the ATS.
currencystringOptionalA string field of the official currency as listed in ISO 4217.
departmentstringOptionalThis is the id of the department from GET/departments.
emailstringOptionalThe candidate's email.
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_PT, SALARIED_FT, HOURLY_FT, HOURLY_PT, TEMP
equitySharesJSONOptional
equityShares (anyOf 1)integerAlternativeThe number of shares that will be given to the candidate.
equityShares (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
jobTitlestringOptionalThe candidate's job title.
namestringOptionalThe candidate's name.
phoneNumberstringOptionalThe candidate's phone number.
salaryPerUnitJSONOptional
salaryPerUnit (anyOf 1)numberAlternativeThe decimal value that the candidate gets paid every salaryUnit time period.
salaryPerUnit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
salaryUnitstringOptionalAn ENUM string value, denoting the frequency at which the candidate should be paid once the role begins. Note, the PAY_PERIOD ENUM implies the candidate is paid as per a custom pay period.
Known values: HOUR, DAY, WEEK, MONTH, PAY_PERIOD
signingBonusJSONOptional
signingBonus (anyOf 1)numberAlternativeThe bonus cash given to the candidate as a part of a one time payment, with two decimal digit precision.
Format: double
signingBonus (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startDatestringOptionalThe would-be start date of the candidate.
Format: date
workLocationstringOptionalThis is the id of the worklocation from GET/work_locations.

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.