Skip to content

Rippling: Rest API schemas (part 9)

6 Rippling schemas with complete fields and constraints.

← Rest API operations · All schemas

Update a worker time split — response body — worker

FieldTypePresenceDescription and constraints
$objectRootThe worker associated with this time split configuration.

Expandable field
business_partnersarrayOptionalWorker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.

Expandable field
business_partners[]ModelEach itemExpand Retrieve a specific worker — response body — business partners item
business_partners_idarrayOptionalWorker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.
business_partners_id[]stringEach item
citizenshipstringOptionalThe countries that the worker has citizenship in.
Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
compensationModelOptionalExpand Retrieve a specific worker — response body — compensation
compensation_gradeobjectOptionalThe compensation grade assigned to the worker, if any.
compensation_grade.idstringOptionalThe compensation grade's unique identifier.
compensation_grade.labelstringOptionalThe compensation grade's label.
compensation_idstringOptionalThe compensation package for the worker.
countrystringOptionalThe worker's country.
Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
country_fieldsModelOptionalExpand Retrieve a specific worker — response body — country fields
created_atstringRequired within parentRecord creation date
custom_fieldsarrayOptionalCustom field values defined on the Employee object for this worker

Expandable field
custom_fields[]JSONEach itemAdditional keys: see wildcard field
custom_fields[].*JSONAdditional keys
date_of_birthstringOptionalThe worker's date of birth.
departmentModelOptionalExpand Retrieve a specific worker — response body — department
department_idstringOptionalThe worker's assigned department.
employment_typeModelOptionalExpand Retrieve a specific worker — response body — employment type
employment_type_idstringOptionalThe worker's employment type.
end_datestringOptionalThe end date of the worker.
ethnicitystringOptionalThe identified ethnicity of the worker, if specified.
Known values: HISPANIC_OR_LATINO, WHITE, BLACK_OR_AFRICAN_AMERICAN, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, ASIAN, AMERICAN_INDIAN_OR_ALASKA_NATIVE, TWO_OR_MORE_RACES, MIDDLE_EASTERN_OR_NORTH_AFRICAN, DECLINE_TO_SELF_IDENTIFY, AFRICAN, COLOURED, INDIAN, OTHER, PREFER_NOT_TO_SAY
genderstringOptionalThe gender of the worker, if specified.
Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY
idstringRequired within parentIdentifier field
is_managerbooleanOptionalWhether the worker is a manager
job_functionobjectOptionalThe worker's job function. When expanded, this field requires `job-functions.read`.

Expandable field
job_function.created_atstringRequired within parentRecord creation date
job_function.idstringRequired within parentIdentifier field
job_function.namestringOptionalDisplayed name of the job function
job_function.updated_atstringRequired within parentRecord update date
job_function_idstringOptionalID of the worker's job function.
legal_entityModelOptionalExpand Retrieve a specific worker — response body — legal entity
legal_entity_idstringOptionalThe worker's associated legal entity.
levelModelOptionalExpand Retrieve a specific worker — response body — level
level_idstringOptionalThe level of the worker.
locationobjectOptionalThe location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.
location.typestringRequired within parentThe type of location.
Known values: REMOTE, WORK
location.work_location_idstringRequired within parentThe work location, if the worker isn't remote.
managerModelOptionalExpand Retrieve a specific worker — response body — manager
The worker's manager.

Expandable field
manager_idstringOptionalThe worker's manager.
numberJSONOptional
number (anyOf 1)integerAlternativeThe worker's number within the organization.
number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
original_start_datestringOptionalThe worker's earliest start date across their employment history, excluding INIT roles.
overtime_exemptionstringOptionalThe worker's overtime exemption status.
Known values: EXEMPT, NON_EXEMPT
pay_schedule_idstringOptionalThe ID of the pay schedule currently associated with the worker.
personal_emailstringOptionalThe worker's associated personal email address.
racestringOptionalThe identified race of the worker, if specified.
Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER
start_datestringOptionalThe start date of the worker.
statusstringOptionalThe worker's status within the organization.
Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED
teamsarrayOptionalThe worker's assigned teams.

Expandable field
teams[]ModelEach itemExpand Update a team — response body — parent
teams_idarrayOptionalThe worker's assigned teams.
teams_id[]stringEach item
termination_detailsobjectOptionalThe details of the worker's termination, if applicable.
termination_details.reasonstringOptionalThis is a description that will be custom to each Rippling company.
termination_details.typestringOptionalThe termination type indicates whether the termination was voluntary or involuntary.
Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE
titlestringOptionalThe worker's title.
title_effective_datestringOptionalTitle effective date
updated_atstringRequired within parentRecord update date
userModelOptionalExpand Retrieve a specific worker — response body — user
user_idstringOptionalThe worker's associated user.
work_emailstringOptionalThe worker's associated work email address.
work_scheduleobjectOptionalThe worker's scheduled working hours for each day of the week.
Additional keys: see wildcard field
work_schedule.*ModelAdditional keysExpand Retrieve a specific worker — response body — work schedule value

Referenced models: Retrieve a specific worker — response body — business partners item, Update a team — response body — parent, Retrieve a specific worker — response body — work schedule value, Retrieve a specific worker — response body — manager, Retrieve a specific worker — response body — compensation, Retrieve a specific worker — response body — country fields, Retrieve a specific worker — response body — department, Retrieve a specific worker — response body — employment type, Retrieve a specific worker — response body — legal entity, Retrieve a specific worker — response body — level, Retrieve a specific worker — response body — user

Update a workflow — request body — body

FieldTypePresenceDescription and constraints
$objectRootMinimum fields: 2
Additional keys: not allowed
actionsarrayOptionalMaximum items: 160
Minimum items: 1
actions[]JSONEach item
actions[] (oneOf 1)ModelAlternativeExpand Create a workflow — request body — body / actions / item / kind: registered callback
descriptionJSONOptional
description (anyOf 1)stringAlternativeMaximum length: 3000
description (anyOf 2)nullAlternative
enabledbooleanOptional
namestringOptionalMaximum length: 150
Minimum length: 1
statusstringOptionalOne of: draft, published
triggerJSONOptional
trigger (oneOf 1)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: annual schedule
trigger (oneOf 2)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: biweekly schedule
trigger (oneOf 3)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: business event
trigger (oneOf 4)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: cron schedule
trigger (oneOf 5)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: custom schedule, unit: minutes, hours, days, weeks, months, years
trigger (oneOf 6)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: daily schedule
trigger (oneOf 7)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: inbound email
trigger (oneOf 8)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: manual
trigger (oneOf 9)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: monthly on day of week schedule
trigger (oneOf 10)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: monthly schedule
trigger (oneOf 11)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: one time schedule
trigger (oneOf 12)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: quarterly schedule
trigger (oneOf 13)ModelAlternativeExpand Create a workflow — request body — body / trigger / event_type: message posted, reaction added, kind: slack
trigger (oneOf 14)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: weekday schedule
trigger (oneOf 15)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: weekly schedule
version_idstringRequired within parentMinimum length: 1

Referenced models: Create a workflow — request body — body / trigger / kind: annual schedule, Create a workflow — request body — body / trigger / kind: biweekly schedule, Create a workflow — request body — body / trigger / kind: business event, Create a workflow — request body — body / trigger / kind: cron schedule, Create a workflow — request body — body / trigger / kind: custom schedule, unit: minutes, hours, days, weeks, months, years, Create a workflow — request body — body / trigger / kind: daily schedule, Create a workflow — request body — body / trigger / kind: inbound email, Create a workflow — request body — body / trigger / kind: manual, Create a workflow — request body — body / trigger / kind: monthly on day of week schedule, Create a workflow — request body — body / trigger / kind: monthly schedule, Create a workflow — request body — body / trigger / kind: one time schedule, Create a workflow — request body — body / trigger / kind: quarterly schedule, Create a workflow — request body — body / actions / item / kind: registered callback, Create a workflow — request body — body / trigger / event_type: message posted, reaction added, kind: slack, Create a workflow — request body — body / trigger / kind: weekday schedule, Create a workflow — request body — body / trigger / kind: weekly schedule

Update an agent — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringOptionalThe description of the agent
namestringOptionalThe display name of the agent

Validate metadata components — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
componentsarrayRequired within parentComplete package of metadata components, including dependencies.
Minimum items: 1
components[]ModelEach itemExpand Extract existing metadata components — response body — component configs item

Referenced models: Extract existing metadata components — response body — component configs item

Validate metadata components — response body

FieldTypePresenceDescription and constraints
$objectRoot
errorsarrayRequired within parentPackage-level validation issues.
errors[]ModelEach itemExpand Deploy a metadata component package — response body — error
resultsarrayRequired within parentPer-component validation results.
results[]ModelEach itemExpand Validate metadata components — response body — results item
validbooleanRequired within parentTrue only when every component and dependency check passed.

Referenced models: Validate metadata components — response body — results item, Deploy a metadata component package — response body — error

Validate metadata components — response body — results item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
errorsarrayOptional
errors[]ModelEach itemExpand Deploy a metadata component package — response body — error
existingobjectOptionalExisting component config matched by the identifier, when available.
Additional keys: allowed
identifierobjectOptionalResolved component identifier.
Additional keys: allowed
mergedobjectOptionalMerged target state for updates, when available.
Additional keys: allowed
normalizedobjectOptionalSchema-normalized component config.
Additional keys: allowed
outcomeJSONOptional
outcome (anyOf 1)stringAlternativeUpsert classification computed during validation.
Known values: CREATE, NO_OP, UPDATE, UNSUPPORTED_UPDATE
outcome (anyOf 2)nullAlternative
typestringRequired within parentMetadata component type.
validbooleanRequired within parentWhether this component passed validation.

Referenced models: Deploy a metadata component package — response body — error

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.