Skip to content

Rippling: Rest API schemas (part 8)

56 Rippling schemas with complete fields and constraints.

← Rest API operations · All schemas

Update a kiosk badge — response body — worker

FieldTypePresenceDescription and constraints
$objectRootThe worker associated with the badge.

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 leave request — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
commentsstringOptionalThe comments associated with the leave request.
end_datestringOptionalThe end date of the leave request.
end_date_custom_hoursnumberOptionalThe number of hours to take off on the end date.
end_timestringOptionalThe end time of the leave request.
leave_event_idstringOptionalThe ID of the leave event associated with the leave request, if any.
leave_policy_idstringOptionalThe ID of the leave policy associated with the leave request, either leave_policy_id or leave_type_id must be provided.
leave_type_idstringOptionalThe ID of the leave type associated with the leave request, either leave_policy_id or leave_type_id must be provided.
reason_for_leavestringOptionalThe reason for the leave request.
requester_idstringOptionalThe ID of the worker who requested the leave request.
reviewed_atstringOptionalThe timestamp of when the leave request was reviewed.
reviewer_idstringOptionalThe ID of the worker who reviewed the leave request.
start_datestringOptionalThe start date of the leave request.
start_date_custom_hoursnumberOptionalThe number of hours to take off on the start date.
start_timestringOptionalThe start time of the leave request.
statusstringOptionalThe status of the leave request.
One of: PENDING, APPROVED, REJECTED, CANCELED
worker_idstringOptionalThe ID of the worker associated with the leave request.

Update a leave request — response body — days take off item

FieldTypePresenceDescription and constraints
$objectRoot
datestringRequired within parentThe date of the day off.
number_of_minutes_taken_offJSONRequired within parent
number_of_minutes_taken_off (anyOf 1)numberAlternativeThe number of minutes taken off for the day.
number_of_minutes_taken_off (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a leave request — response body — leave type

FieldTypePresenceDescription and constraints
$objectRootThe leave type associated with the leave request.

Expandable field
created_atstringRequired within parentRecord creation date
descriptionstringOptionalThe description of the leave type.
idstringRequired within parentIdentifier field
is_managed_by_external_systembooleanRequired within parentWhether the leave is managed by an external system.
is_paidbooleanRequired within parentWhether the leave is paid.
namestringRequired within parentThe name of the leave type.
typestringRequired within parentThe type of leave.
updated_atstringRequired within parentRecord update date

Update a leave request — response body — requester

FieldTypePresenceDescription and constraints
$objectRootThe worker who requested the leave request.

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 leave request — response body — reviewer

FieldTypePresenceDescription and constraints
$objectRootThe worker who reviewed the leave request.

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 leave request — response body — worker

FieldTypePresenceDescription and constraints
$objectRootThe worker associated with the leave request.

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 level — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringOptionalThe description of the level.
experience_requirementsstringOptionalThe experience requirements for the level.
global_levelintegerOptionalGlobal level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).
namestringOptionalThe name of the level. Must be unique within the company or organization.
scope_of_responsibilitiesstringOptionalThe scope of responsibilities for the level.
track_idstringOptionalThe track associated with the level. Required during creation. Include global_level when changing it.

Update a level — response body — parent

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
descriptionstringOptionalThe description of the level.
experience_requirementsstringOptionalThe experience requirements for the level.
global_levelJSONOptional
global_level (anyOf 1)integerAlternativeGlobal level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).
global_level (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the level. Must be unique within the company or organization.
parentModelOptionalExpand Update a level — response body — parent
The parent level.

Expandable field
parent_idstringOptionalThe parent level.
rankJSONOptional
rank (anyOf 1)integerAlternativeThe rank of the level within its track.
rank (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
scope_of_responsibilitiesstringOptionalThe scope of responsibilities for the level.
trackModelOptionalExpand Update a level — response body — track
track_idstringOptionalThe track associated with the level. Required during creation. Include global_level when changing it.
updated_atstringRequired within parentRecord update date

Referenced models: Update a level — response body — parent, Update a level — response body — track

Update a level — response body — track

FieldTypePresenceDescription and constraints
$objectRootThe track associated with the level, if it's not a global level.

Expandable field
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
is_defaultbooleanOptionalWhether this is the company's default track.
namestringRequired within parentThe name of the track. Must be unique within the company or organization.
orderJSONOptional
order (anyOf 1)integerAlternativeThe one-based horizontal display order of the track.
order (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_global_levelJSONOptional
start_global_level (anyOf 1)integerAlternativeThe highest global level occupied by this track. Empty tracks return null.
start_global_level (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentRecord update date

Update a listing — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
draft_statusstringOptionalThe current draft-cycle slot status.
draft_versionModelOptionalExpand Delist listing — response body — draft version
draft_version_idstringOptionalThe current draft-cycle version ID.
iconstringOptionalThe listing icon URL.
listing_idstringOptionalThe listing ID.
namestringOptionalThe listing name or display name.
owner_company_idstringOptionalThe publisher company ID that owns this listing.
published_or_delisted_versionModelOptionalExpand Delist listing — response body — published or delisted version
published_statusstringOptionalThe current published slot status.
published_version_idstringOptionalThe current published or delisted version ID.
statusstringOptionalThe listing lifecycle status.
typestringOptionalThe listing app type.

Referenced models: Delist listing — response body — draft version, Delist listing — response body — published or delisted version

Update a package — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringOptionalThe description of the package
package_display_namestringRequired within parentThe display name of the package
package_keystringRequired within parentThe unique package key within the publisher company
package_typestringRequired within parentThe package type
One of: MANAGED, UNMANAGED

Update a schedule — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
managers_idarrayOptionalThe IDs of the managers of the schedule.
managers_id[]stringEach item
members_idarrayOptionalThe IDs of the members of the schedule.
members_id[]stringEach item
namestringOptionalThe name of the schedule.
observers_idarrayOptionalThe IDs of the observers of the schedule.
observers_id[]stringEach item
settingsobjectOptionalThe settings of the schedule.
settings.timezonestringOptionalThe IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Update a shift assignment — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
is_publishedbooleanRequired within parentWhether the shift assignment is published. If true, the published_version will be the same as the shift_data
shift_dataModelRequired within parentExpand Update a shift assignment — request body — body shift data
worker_idstringRequired within parentThe ID of the worker. Empty string '' to unassign if shift is from an open/empty shift.

Referenced models: Update a shift assignment — request body — body shift data

Update a shift assignment — request body — body shift data

FieldTypePresenceDescription and constraints
$objectRootThe data of the shift
end_timestringRequired within parentThe end time of the shift
notesstringOptionalNotes for the shift, max length 256 characters
Maximum length: 256
shift_breaksarrayOptionalThe breaks of the shift
shift_breaks[]ModelEach itemExpand Update a shift assignment — request body — body shift data shift breaks item
shift_segmentsarrayOptionalThe segments of the shift
shift_segments[]ModelEach itemExpand Update a shift assignment — request body — body shift data shift segments item
start_timestringRequired within parentThe start time of the shift

Referenced models: Update a shift assignment — request body — body shift data shift breaks item, Update a shift assignment — request body — body shift data shift segments item

Update a shift assignment — request body — body shift data shift breaks item

FieldTypePresenceDescription and constraints
$objectRoot
duration_minutesintegerRequired within parentThe duration of the shift break in minutes (input only for creation)
start_timestringRequired within parentThe start time of the shift break
typestringRequired within parentThe type of the shift break
One of: MEAL, REST

Update a shift assignment — request body — body shift data shift segments item

FieldTypePresenceDescription and constraints
$objectRoot
duration_minutesintegerRequired within parentThe duration of the shift segment in minutes (input only for creation)
job_codes_idarrayOptionalThe IDs of the job codes associated with the shift segment
job_codes_id[]stringEach item
start_timestringRequired within parentThe start time of the shift segment

Update a shift assignment — response body — published version

FieldTypePresenceDescription and constraints
$objectRootThe published version of the shift assignment, if it exists. If filled but is_published is false, the shift_data is the latest version.
end_timestringRequired within parentThe end time of the shift
notesstringOptionalNotes for the shift, max length 256 characters
Maximum length: 256
shift_breaksarrayOptionalThe breaks of the shift
shift_breaks[]ModelEach itemExpand Update a shift assignment — response body — shift data shift breaks item
shift_segmentsarrayOptionalThe segments of the shift
shift_segments[]ModelEach itemExpand Update a shift assignment — response body — shift data shift segments item
start_timestringRequired within parentThe start time of the shift

Referenced models: Update a shift assignment — response body — shift data shift breaks item, Update a shift assignment — response body — shift data shift segments item

Update a shift assignment — response body — schedule

FieldTypePresenceDescription and constraints
$objectRootThe schedule

Expandable field
can_editbooleanOptionalWhether the requesting role can edit the schedule.
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
managersarrayOptionalThe managers of the schedule.

Expandable field
managers[]ModelEach itemExpand Retrieve a specific worker — response body — manager
managers_idarrayOptionalThe IDs of the managers of the schedule.
managers_id[]stringEach item
membersarrayOptionalThe members of the schedule.

Expandable field
members[]ModelEach itemExpand Retrieve a specific worker — response body — manager
members_idarrayOptionalThe IDs of the members of the schedule.
members_id[]stringEach item
namestringOptionalThe name of the schedule.
observersarrayOptionalThe observers of the schedule.

Expandable field
observers[]ModelEach itemExpand Retrieve a specific worker — response body — manager
observers_idarrayOptionalThe IDs of the observers of the schedule.
observers_id[]stringEach item
settingsobjectOptionalThe settings of the schedule.
settings.timezonestringOptionalThe IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
updated_atstringRequired within parentRecord update date

Referenced models: Retrieve a specific worker — response body — manager

Update a shift assignment — response body — shift data

FieldTypePresenceDescription and constraints
$objectRootThe data of the shift
end_timestringRequired within parentThe end time of the shift
notesstringOptionalNotes for the shift, max length 256 characters
Maximum length: 256
shift_breaksarrayOptionalThe breaks of the shift
shift_breaks[]ModelEach itemExpand Update a shift assignment — response body — shift data shift breaks item
shift_segmentsarrayOptionalThe segments of the shift
shift_segments[]ModelEach itemExpand Update a shift assignment — response body — shift data shift segments item
start_timestringRequired within parentThe start time of the shift

Referenced models: Update a shift assignment — response body — shift data shift breaks item, Update a shift assignment — response body — shift data shift segments item

Update a shift assignment — response body — shift data shift breaks item

FieldTypePresenceDescription and constraints
$objectRoot
duration_minutesJSONRequired within parent
duration_minutes (anyOf 1)integerAlternativeThe duration of the shift break in minutes (input only for creation)
duration_minutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
end_timestringOptionalThe end time of the shift break (calculated from start_time + duration_minutes)
start_timestringRequired within parentThe start time of the shift break
typestringRequired within parentThe type of the shift break
Known values: MEAL, REST

Update a shift assignment — response body — shift data shift segments item

FieldTypePresenceDescription and constraints
$objectRoot
duration_minutesJSONRequired within parent
duration_minutes (anyOf 1)integerAlternativeThe duration of the shift segment in minutes (input only for creation)
duration_minutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
end_timestringOptionalThe end time of the shift segment (calculated from start_time + duration_minutes)
job_codes_idarrayOptionalThe IDs of the job codes associated with the shift segment
job_codes_id[]stringEach item
start_timestringRequired within parentThe start time of the shift segment

Update a shift assignment — response body — worker

FieldTypePresenceDescription and constraints
$objectRootThe worker

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 shift input — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
country_codestringOptionalTwo letter string designating country code which the shift input is associated.
creator_idstringOptionalThe creator id associated with the shift input.
namestringOptionalName of the shift unit.
promptstringOptionalPrompt for the shift unit.
typestringOptionalType of shift unit.

Update a shift input — response body — creator

FieldTypePresenceDescription and constraints
$objectRootThe creator associated with the shift input.

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 site — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest body for create/PATCH using a staged upload file_id.
api_namestringOptionalThe unique api name of the custom site
descriptionstringOptionalThe optional description of the custom site
entry_pathstringOptionalEntry path inside the uploaded asset (for example index.html). Required with file_id when the zip has no index.html.
file_idstringOptionalStaged upload id from POST /sites/upload-batches/presign/ after uploading bytes to S3. Required to create a site or replace the bundle. The id can be reused for 1 hour from presign, each attach copies the bytes into that site's bundle, a repeat attach before expiry creates another bundle, and the staged object is removed after expiry.
logostringOptionalA Rippling-owned logo URL for the custom site
namestringOptionalThe display name of the custom site

Update a software deployment — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
active_group_typestringOptionalType of group targeting: 'Role' or 'Device'.
One of: Role, Device
group_idstringOptionalGroup ID for role-based targeting. Required if active_group_type is 'Role'. Must be null if 'Device'.
ma_device_group_idstringOptionalDevice group ID for device-based targeting. Required if active_group_type is 'Device'. Must be null if 'Role'.
software_idstringOptionalThe ID of the software to deploy.

Update a software deployment — response body — software

FieldTypePresenceDescription and constraints
$objectRootThe software being deployed. Expandable to get software name, icon, and metadata.

Expandable field
available_platformsarrayOptionalPlatforms this software is available on (macOS, Windows, etc).
available_platforms[]stringEach item
categorystringOptionalCategory of the software.
created_atstringRequired within parentRecord creation date
descriptionstringOptionalDescription of the software.
display_namestringOptionalCustom display name for the software.
icon_urlstringOptionalURL for the software icon.
idstringRequired within parentIdentifier field
namestringOptionalThe name of the software.
scopestringOptionalScope of the software (PUBLIC, CUSTOM, INTERNAL).
updated_atstringRequired within parentRecord update date

Update a team — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe name of the team.
parent_idstringOptionalThe parent team

Update a team — response body — parent

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the team.
parentModelOptionalExpand Update a team — response body — parent
The parent team

Expandable field
parent_idstringOptionalThe parent team
updated_atstringRequired within parentRecord update date

Referenced models: Update a team — response body — parent

Update a time entry — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
breaksarrayOptionalThe breaks taken during the time entry.
breaks[]ModelEach itemExpand Update a time entry — request body — body breaks item
commentsarrayOptionalThe comments associated with the time entry.
comments[]ModelEach itemExpand Update a time entry — request body — body comments item
create_extra_hours_runbooleanOptionalWhether the time entry should create an extra hours run.
durationnumberOptionalThe duration of the time entry.
idempotency_keystringOptionalThe unique key of the time entry in an outside system. If set, no other time entry with the same key can be created.
job_shiftsarrayOptionalThe job shifts worked during the time entry.
job_shifts[]ModelEach itemExpand Update a time entry — request body — body job shifts item
pay_periodobjectOptionalThe pay period associated with the time card.
pay_period.end_datestringOptionalThe end date of the pay period.
pay_period.pay_schedule_idstringOptionalThe ID of the pay schedule associated with the pay period.
pay_period.start_datestringOptionalThe start date of the pay period.
shift_input_valuesarrayOptionalArbitrary shift inputs collected on the time entry
shift_input_values[]ModelEach itemExpand Update a time entry — response body — shift input values item
start_datestringOptionalThe date of the time entry if using duration.
statusstringOptionalThe status of the time entry.
One of: DRAFT, APPROVED, PAID, FINALIZED
tagsarrayOptionalThe tags associated with the time entry.
tags[]stringEach item
worker_idstringRequired within parentThe ID of the worker associated with the time entry.

Referenced models: Update a time entry — response body — shift input values item, Update a time entry — request body — body breaks item, Update a time entry — request body — body job shifts item, Update a time entry — request body — body comments item

Update a time entry — request body — body breaks item

FieldTypePresenceDescription and constraints
$objectRoot
break_type_idstringOptionalThe ID of the break type.
end_timestringOptionalThe end time of the break.
start_timestringOptionalThe start time of the break.

Update a time entry — request body — body comments item

FieldTypePresenceDescription and constraints
$objectRoot
textstringOptionalThe text of the comment.

Update a time entry — request body — body job shifts item

FieldTypePresenceDescription and constraints
$objectRoot
durationnumberOptionalThe duration of the job shift.
end_timestringOptionalThe end time of the job shift.
is_hours_only_inputbooleanOptionalWhether the job shift was entered as a duration in hours table
job_codes_idarrayOptionalThe IDs of the job codes associated with the job shift.
job_codes_id[]stringEach item
original_end_timestringOptionalThe original end time of the job shift. If the endTime field has been rounded then this contain the end time before the rounding occured.
original_start_timestringOptionalThe original start time of the job shift. If the startTime field has been rounded then this contain the start time before the rounding occured.
start_datestringOptionalThe date of the job shift if using duration.
start_timestringOptionalThe start time of the job shift.

Update a time entry — response body — breaks item

FieldTypePresenceDescription and constraints
$objectRoot
break_type_idstringOptionalThe ID of the break type.
end_timestringOptionalThe end time of the break.
original_end_timestringOptionalThe original end time of the break. If the endTime field has been rounded then this contain the end time before the rounding occured.
original_start_timestringOptionalThe original start time of the break. If the startTime field has been rounded then this contain the start time before the rounding occured.
start_timestringOptionalThe start time of the break.

Update a time entry — response body — comments item

FieldTypePresenceDescription and constraints
$objectRoot
author_idstringOptionalThe ID of the worker who made of the comment.
created_atstringOptionalThe time the comment was created.
textstringOptionalThe text of the comment.

Update a time entry — response body — job shifts item

FieldTypePresenceDescription and constraints
$objectRoot
end_timestringOptionalThe end time of the job shift.
is_hours_only_inputbooleanOptionalWhether the job shift was entered as a duration in hours table
job_codes_idarrayOptionalThe IDs of the job codes associated with the job shift.
job_codes_id[]stringEach item
original_end_timestringOptionalThe original end time of the job shift. If the endTime field has been rounded then this contain the end time before the rounding occured.
original_start_timestringOptionalThe original start time of the job shift. If the startTime field has been rounded then this contain the start time before the rounding occured.
start_timestringOptionalThe start time of the job shift.

Update a time entry — response body — piece rate premiums item

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe piece rate name.
premium_rateJSONOptional
premium_rate (anyOf 1)numberAlternativeThe pay rate for this piece rate premium.
premium_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
premium_unitsJSONOptional
premium_units (anyOf 1)numberAlternativeThe total units produced at the premium rate.
premium_units (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a time entry — response body — premiums item

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe pay rate name
premium_hoursJSONOptional
premium_hours (anyOf 1)numberAlternativeThe total hours worked for at the premium rate.
premium_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
premium_rateJSONOptional
premium_rate (anyOf 1)numberAlternativeThe pay rate for this premium.
premium_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a time entry — response body — segments item

FieldTypePresenceDescription and constraints
$objectRoot
break_type_idstringOptionalThe ID of the break type.
display_namestringOptionalName of the final earning for the segment.
end_timestringOptionalThe end time of the segment.
job_codes_idarrayOptionalThe IDs of the job codes associated with the segment.
job_codes_id[]stringEach item
ot_multiplierJSONOptional
ot_multiplier (anyOf 1)numberAlternativeThe multiplier for overtime hours in this segment.
ot_multiplier (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pay_rateJSONOptional
pay_rate (anyOf 1)numberAlternativeThe pay rate for this segment.
pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_timestringOptionalThe start time of the segment.

Update a time entry — response body — shift input values item

FieldTypePresenceDescription and constraints
$objectRoot
author_idstringOptionalThe id of the role that last added/updated this input.
shift_input_idstringRequired within parentThe id of the relevant shift input
valueobjectRequired within parentThe value of the shift input.

Update a time entry — response body — time card

FieldTypePresenceDescription and constraints
$objectRootThe time card associated with the time entry.

Expandable field
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
pay_periodobjectOptionalThe pay period associated with the time card.
pay_period.end_datestringOptionalThe end date of the pay period.
pay_period.pay_schedule_idstringOptionalThe ID of the pay schedule associated with the pay period.
pay_period.start_datestringOptionalThe start date of the pay period.
summaryModelOptionalExpand Retrieve a specific time card — response body — summary
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific time card — response body — worker
worker_idstringRequired within parentThe ID of the worker associated with the time card.

Referenced models: Retrieve a specific time card — response body — summary, Retrieve a specific time card — response body — worker

Update a time entry — response body — time entry summary

FieldTypePresenceDescription and constraints
$objectRootA summary of the time entry.
double_over_time_hoursJSONOptional
double_over_time_hours (anyOf 1)numberAlternativeThe number of double overtime hours worked during this time entry.
double_over_time_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
durationJSONOptional
duration (anyOf 1)numberAlternativeThe duration of the time entry.
duration (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
over_time_hoursJSONOptional
over_time_hours (anyOf 1)numberAlternativeThe number of overtime hours worked during this time entry.
over_time_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
regular_hoursJSONOptional
regular_hours (anyOf 1)numberAlternativeThe number of regular hours worked during this time entry.
regular_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a time entry — response body — worker

FieldTypePresenceDescription and constraints
$objectRootThe worker associated with the time entry.

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 title — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentThe name of the title.

Update a track — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe name of the track. Must be unique within the company or organization.
orderintegerOptionalThe one-based horizontal display order of the track.

Update a unassigned shift — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
is_publishedbooleanRequired within parentWhether the shift is published
open_shift_configobjectOptionalConfiguration for an open shift. If present, this is an open shift (workers can sign up). If absent/None, this is an empty shift (placeholder).
shift_dataModelRequired within parentExpand Update a shift assignment — request body — body shift data
target_countintegerRequired within parentThe target count of the shift

Referenced models: Update a shift assignment — request body — body shift data

Update a unassigned shift — response body — published version

FieldTypePresenceDescription and constraints
$objectRootThe published version of the shift
end_timestringRequired within parentThe end time of the shift
notesstringOptionalNotes for the shift, max length 256 characters
Maximum length: 256
shift_breaksarrayOptionalThe breaks of the shift
shift_breaks[]ModelEach itemExpand Update a shift assignment — response body — shift data shift breaks item
shift_segmentsarrayOptionalThe segments of the shift
shift_segments[]ModelEach itemExpand Update a shift assignment — response body — shift data shift segments item
start_timestringRequired within parentThe start time of the shift

Referenced models: Update a shift assignment — response body — shift data shift breaks item, Update a shift assignment — response body — shift data shift segments item

Update a variable compensation payout label — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
clientstringRequired within parentClient system that created the label.
external_idstringRequired within parentExternal identifier unique per company and client.
namestringRequired within parentDisplay name of the label.

Update a variable compensation payout type — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parentDisplay name of the payout type.
mappingsarrayOptionalPer-entity earning code mappings.
mappings[]ModelEach itemExpand Update a variable compensation payout type — response body — mappings item

Referenced models: Update a variable compensation payout type — response body — mappings item

Update a variable compensation payout type — response body — mappings item

FieldTypePresenceDescription and constraints
$objectRoot
earning_codestringOptionalMapped earning code for the payroll entity.
earning_display_namestringOptionalDisplay name of the mapped earning code at response time. Convenience snapshot for the mapping matrix; authoritative earning metadata lives in payroll, not this field.
entity_idstringRequired within parentID of the payroll entity this mapping applies to.
entity_namestringOptionalDisplay name of the payroll entity at response time. Convenience snapshot for the mapping matrix; authoritative entity data lives on payroll entities, not this field.
healthstringRequired within parentMapping health status.

Update a work location — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
addressModelOptionalExpand Update a work location — request body — body address
namestringOptionalThe name of the work location.

Referenced models: Update a work location — request body — body address

Update a work location — request body — body address

FieldTypePresenceDescription and constraints
$objectRootThe address for the work location.
countrystringOptionalThe country component, pursuant to SCIM RFC 7643 4.1.2.
One of: 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
localitystringOptionalThe city or locality component.
postal_codestringOptionalThe zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
regionstringOptionalThe state or region component, pursuant to SCIM RFC 7643 4.1.2.
street_addressstringOptionalThe full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..
typestringOptionalThe classification of the address.
One of: HOME, WORK, OTHER

Update a work location — response body — address

FieldTypePresenceDescription and constraints
$objectRootThe address for the work location.
countrystringOptionalThe country component, pursuant to SCIM RFC 7643 4.1.2.
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
formattedstringOptionalThe formatted mailing address.
localitystringOptionalThe city or locality component.
postal_codestringOptionalThe zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
regionstringOptionalThe state or region component, pursuant to SCIM RFC 7643 4.1.2.
street_addressstringOptionalThe full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..
typestringOptionalThe classification of the address.
Known values: HOME, WORK, OTHER

Update a worker time split — request body — body

FieldTypePresenceDescription and constraints
$objectRootWorker time split configuration resource.
is_enabledbooleanOptionalWhether hard-coded time splits are active for this worker.
splitsarrayOptionalThe split rows defining time allocation percentages across job codes. Empty when is_enabled is false.
splits[]ModelEach itemExpand Update a worker time split — response body — splits item
worker_idstringRequired within parentIdentifier of the worker whose time split configuration this represents.

Referenced models: Update a worker time split — response body — splits item

Update a worker time split — response body — splits item

FieldTypePresenceDescription and constraints
$objectRootA single split row representing a percentage allocation across one or more job codes.
job_code_idsarrayOptionalIDs of canonical /job-codes/ resources in this split row.
job_code_ids[]stringEach item
split_percentagestringOptionalPercentage allocated to this split row. Decimal string with precision 2; must be greater than zero per row. All rows must sum to 100.00 when is_enabled is true.

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.