Skip to content

Rippling: Rest API schemas (part 6)

37 Rippling schemas with complete fields and constraints.

← Rest API operations · All schemas

Retrieve a specific headcount position — response body — headcount owner

FieldTypePresenceDescription and constraints
$objectRootOwner of the headcount

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

Retrieve a specific headcount position — response body — job requisition

FieldTypePresenceDescription and constraints
$objectRootJob requisition the headcount is associated with

Expandable field
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
namestringRequired within parentJob requisition name
statusstringRequired within parentJob requisition status
Known values: OPEN, CLOSED, PUBLISHED, DRAFT, ARCHIVED
updated_atstringRequired within parentRecord update date

Retrieve a specific headcount position — response body — level

FieldTypePresenceDescription and constraints
$objectRootLevel the headcount is assigned to

Expandable field
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

Retrieve a specific headcount position — response body — location factor

FieldTypePresenceDescription and constraints
$objectRootLocation factor assigned to this headcount

Expandable field
adjustment_factorJSONOptional
adjustment_factor (anyOf 1)numberAlternativeCompensation adjustment percentage
adjustment_factor (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
countryModelOptionalExpand Retrieve a specific location factor — response body — country
created_atstringRequired within parentRecord creation date
display_namestringOptionalHuman-readable name for the location factor
idstringRequired within parentIdentifier field
labour_bucketstringOptionalThe labor market category (e.g., "Engineering", "Marketing", "Sales")
updated_atstringRequired within parentRecord update date

Referenced models: Retrieve a specific location factor — response body — country

Retrieve a specific headcount position — response body — recruiter

FieldTypePresenceDescription and constraints
$objectRootRecruiter working on filling the position

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

Retrieve a specific headcount position — response body — work location

FieldTypePresenceDescription and constraints
$objectRootWork location the headcount is assigned to

Expandable field
addressModelRequired within parentExpand Update a work location — response body — address
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the work location.
updated_atstringRequired within parentRecord update date

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

Retrieve a specific headcount position — response body — worker

FieldTypePresenceDescription and constraints
$objectRootWorker hired into the headcount

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

Retrieve a specific job pay rate exception — response body — job code

FieldTypePresenceDescription and constraints
$objectRootJob for which exception is configured.

Expandable field
created_atstringRequired within parentRecord creation date
custom_locationModelOptionalExpand Update a job code — response body — custom location
departmentModelOptionalExpand Update a job code — response body — department
department_idstringOptionalThe department associated with the job code.
external_idstringOptionalThe unique identifier of the job code in an outside system.
group_idstringOptionalThe ID of the job roster group.
idstringRequired within parentIdentifier field
is_archivedbooleanOptionalWhether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.
job_dimensionModelOptionalExpand Update a job code — response body — job dimension
job_dimension_idstringRequired within parentThe ID of the job dimension this job code belongs to.
namestringRequired within parentThe name of the job dimension.
pay_rateJSONOptional
pay_rate (anyOf 1)numberAlternativeThe pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.
pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pay_rate_exceptionsarrayOptionalPay rate overrides for the job based on exception dimension values.

Expandable field
pay_rate_exceptions[]ModelEach itemExpand List job pay rate exceptions — response body — results item
pay_rate_exceptions_idarrayOptionalPay rate overrides id for the job based on exception dimension values.
pay_rate_exceptions_id[]stringEach item
updated_atstringRequired within parentRecord update date
work_locationModelOptionalExpand Update a job code — response body — work location
work_location_idstringOptionalThe work location associated with the job code.

Referenced models: List job pay rate exceptions — response body — results item, Update a job code — response body — custom location, Update a job code — response body — department, Update a job code — response body — job dimension, Update a job code — response body — work location

Retrieve a specific leave balance — response body — leave type

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

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

Retrieve a specific leave balance — response body — worker

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

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

Retrieve a specific legal entity — response body — company

FieldTypePresenceDescription and constraints
$objectRootThe company or organization associated with the legal entity

Expandable field
created_atstringRequired within parentRecord creation date
doing_business_as_namestringOptionalThe doing business as name for the company.
idstringRequired within parentIdentifier field
legal_entitiesarrayRequired within parentA list of the company's entities.

Expandable field
legal_entities[]ModelEach itemExpand Retrieve a specific legal entity — response body — parent
legal_entities_idarrayRequired within parentA list of the company's entities.
legal_entities_id[]stringEach item
legal_namestringOptionalThe legal name of the company.
namestringRequired within parentThe name of the company.
parent_legal_entityModelOptionalExpand Retrieve a specific legal entity — response body — parent
The company's ultimate holding entity.

Expandable field
parent_legal_entity_idstringOptionalThe company's ultimate holding entity.
phonestringOptionalThe phone number for the company.
physical_addressModelOptionalExpand Retrieve my SSO information — response body — company physical address
primary_emailstringOptionalThe email address used when registering this company.
updated_atstringRequired within parentRecord update date

Referenced models: Retrieve a specific legal entity — response body — parent, Retrieve my SSO information — response body — company physical address

Retrieve a specific legal entity — response body — country

FieldTypePresenceDescription and constraints
$objectRootThe country the legal entity is based in.
codestringRequired within parentThe code of the 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

Retrieve a specific legal entity — response body — mailing address

FieldTypePresenceDescription and constraints
$objectRootThe mailing address of the legal entity.
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

Retrieve a specific legal entity — response body — parent

FieldTypePresenceDescription and constraints
$objectRoot
companyModelOptionalExpand Retrieve a specific legal entity — response body — company
company_idstringOptionalThe company or organization associated with the legal entity
countryModelOptionalExpand Retrieve a specific legal entity — response body — country
created_atstringRequired within parentRecord creation date
entity_levelstringOptionalThe legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.
Known values: PARENT, SUBSIDIARY, BRANCH
idstringRequired within parentIdentifier field
legal_namestringOptionalThe legal name of the legal entity.
mailing_addressModelOptionalExpand Retrieve a specific legal entity — response body — mailing address
management_typestringOptionalThe legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).
Known values: PEO, EOR, COR
parentModelOptionalExpand Retrieve a specific legal entity — response body — parent
The parent legal entity.

Expandable field
parent_idstringOptionalThe parent legal entity.
physical_addressModelOptionalExpand Retrieve a specific legal entity — response body — physical address
registration_datestringOptionalThe registration date of the entity.
tax_identifierstringOptionalThe tax identifier for the legal entity.
updated_atstringRequired within parentRecord update date

Referenced models: Retrieve a specific legal entity — response body — parent, Retrieve a specific legal entity — response body — company, Retrieve a specific legal entity — response body — country, Retrieve a specific legal entity — response body — mailing address, Retrieve a specific legal entity — response body — physical address

Retrieve a specific legal entity — response body — physical address

FieldTypePresenceDescription and constraints
$objectRootThe physical address of the legal entity, if it differs from the mailing address.
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

Retrieve a specific location factor — response body — country

FieldTypePresenceDescription and constraints
$objectRootCountry information set to the country code
codestringRequired within parentThe code of the 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

Retrieve a specific reimbursement — response body — end location

FieldTypePresenceDescription and constraints
$objectRootEnd of a mileage trip. Null except on mileage reimbursements.
addressstringOptionalAddress of this point. Null when the point has no address.
coordinatesModelOptionalExpand Retrieve a specific reimbursement — response body — end location coordinates

Referenced models: Retrieve a specific reimbursement — response body — end location coordinates

Retrieve a specific reimbursement — response body — end location coordinates

FieldTypePresenceDescription and constraints
$objectRootLatitude and longitude of this point, in decimal degrees. Null when the point has no coordinates.
latitudeJSONOptional
latitude (anyOf 1)numberAlternativeLatitude of this point, in decimal degrees.
latitude (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
longitudeJSONOptional
longitude (anyOf 1)numberAlternativeLongitude of this point, in decimal degrees.
longitude (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a specific reimbursement — response body — mileage rate

FieldTypePresenceDescription and constraints
$objectRootCompany mileage rate. Include with `expand=mileage_rate` using `reimbursements.read`.

Expandable field
countrystringOptionalISO 3166-1 alpha-2 country code.
created_atstringRequired within parentWhen the mileage rate was created, as an ISO 8601 date-time in UTC.
end_datestringOptionalEffective end date of the rate, as an ISO 8601 date (YYYY-MM-DD).
half_centbooleanOptionalWhether an additional half cent per distance unit applies.
idstringRequired within parentCompany mileage rate ID.
namestringOptionalCompany-defined label for this mileage rate, such as the rate used for a country or vehicle type.
rateobjectOptionalAmount per distance unit. The `value` is a decimal string.
rate.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
rate.valueJSONOptional
rate.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
rate.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_datestringOptionalEffective start date of the rate, as an ISO 8601 date (YYYY-MM-DD).
unitsstringOptionalDistance unit, mi or km.
Known values: km, mi
updated_atstringRequired within parentWhen the mileage rate was last updated, as an ISO 8601 date-time in UTC.

Retrieve a specific reimbursement — response body — per diem line items item

FieldTypePresenceDescription and constraints
$objectRoot
amountobjectOptionalSub-rate amount for one unit. The `value` is a decimal string.
amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
amount.valueJSONOptional
amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
calculated_amountobjectOptionalamount times count. The `value` is a decimal string. Negative when line_type is EXCLUDE.
calculated_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
calculated_amount.valueJSONOptional
calculated_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
calculated_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
countJSONOptional
count (anyOf 1)integerAlternativeHow many units.
count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
labelstringOptionalSub-rate label.
line_typestringOptional`INCLUDE`: this row is added to the reimbursement. `EXCLUDE`: this row is subtracted. `calculated_amount.value` is negative when excluded.
Known values: INCLUDE, EXCLUDE
sub_rate_idstringOptionalPer diem sub-rate ID.
sub_rate_typestringOptional`FULL_DAY`: the full daily allowance. `MEALS`: the meals portion of the daily allowance. `OTHERS`: an allowance that is not the full day or meals.
Known values: FULL_DAY, MEALS, OTHERS

Retrieve a specific reimbursement — response body — per diem rate

FieldTypePresenceDescription and constraints
$objectRootPer diem rate for the trip. Include with `expand=per_diem_rate` using `reimbursements.read`.

Expandable field
countrystringOptionalCountry this per diem rate applies to, as an ISO 3166-1 alpha-2 code. Example: US.
created_atstringRequired within parentWhen the per diem rate was created, as an ISO 8601 date-time in UTC.
currencystringOptionalCurrency of the per diem rate, as an ISO 4217 code. Example: USD.
destination_namestringOptionalPlace this per diem rate applies to, such as a city.
end_datestringOptionalEffective end date of the rate, as an ISO 8601 date (YYYY-MM-DD).
idstringRequired within parentPer diem rate ID.
is_archivedbooleanOptionalWhether the rate is archived. Archived rates remain readable for historical references.
is_currentbooleanOptionalWhether this is the current version of the rate.
start_datestringOptionalEffective start date of the rate, as an ISO 8601 date (YYYY-MM-DD).
updated_atstringRequired within parentWhen the per diem rate was last updated, as an ISO 8601 date-time in UTC.

Retrieve a specific reimbursement — response body — start location

FieldTypePresenceDescription and constraints
$objectRootStart of a mileage trip. Null except on mileage reimbursements.
addressstringOptionalAddress of this point. Null when the point has no address.
coordinatesModelOptionalExpand Retrieve a specific reimbursement — response body — end location coordinates

Referenced models: Retrieve a specific reimbursement — response body — end location coordinates

Retrieve a specific reimbursement — response body — vendor

FieldTypePresenceDescription and constraints
$objectRootVendor details. Expand with `reimbursements.read` and `finance-vendors.read`.

Expandable field
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
is_archivedbooleanOptionalWhether the vendor is archived. Archived vendors remain available for historical references.
logostringOptionalURL of the vendor's logo. Null when no logo is available.
namestringOptionalCanonical name of the Finance vendor. Name eq, ne, and in filters also match alternate names.
updated_atstringRequired within parentRecord update date

Retrieve a specific reimbursement — response body — waypoints item

FieldTypePresenceDescription and constraints
$objectRootStart, end, or intermediate stop on a mileage trip.
addressstringOptionalAddress of this point. Null when the point has no address.
coordinatesModelOptionalExpand Retrieve a specific reimbursement — response body — end location coordinates

Referenced models: Retrieve a specific reimbursement — response body — end location coordinates

Retrieve a specific reimbursement — response body — worker

FieldTypePresenceDescription and constraints
$objectRootWorker details. Expand with `reimbursements.read` and `workers.read`.

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

Retrieve a specific time card — response body — summary

FieldTypePresenceDescription and constraints
$objectRootThe summary of the time card.
approved_hoursJSONOptional
approved_hours (anyOf 1)numberAlternativeThe approved hours for the pay period.
approved_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
double_overtime_hoursJSONOptional
double_overtime_hours (anyOf 1)numberAlternativeThe total number of doubletime hours worked during the pay period.
double_overtime_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
earningsJSONOptional
earnings (anyOf 1)numberAlternativeThe earnings for the pay period.
earnings (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hours_worked_by_job_codearrayOptionalThe amount of hours worked for each job code for the pay period.
hours_worked_by_job_code[]ModelEach itemExpand Retrieve a specific time card — response body — summary hours worked by job code item
overtime_hoursJSONOptional
overtime_hours (anyOf 1)numberAlternativeThe total number of overtime hours worked during the pay period.
overtime_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
paid_hoursJSONOptional
paid_hours (anyOf 1)numberAlternativeThe paid hours for the pay period.
paid_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
premiumsJSONOptional
premiums (anyOf 1)numberAlternativeThe premiums for the pay period.
premiums (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
regular_hoursJSONOptional
regular_hours (anyOf 1)numberAlternativeThe total number of regular hours worked during the pay period.
regular_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_holiday_hoursJSONOptional
total_holiday_hours (anyOf 1)numberAlternativeThe total holiday hours for the pay period.
total_holiday_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_hoursJSONOptional
total_hours (anyOf 1)numberAlternativeThe total hours for the pay period.
total_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_paid_time_off_hoursJSONOptional
total_paid_time_off_hours (anyOf 1)numberAlternativeThe total paid time off hours for the pay period.
total_paid_time_off_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_unpaid_time_off_hoursJSONOptional
total_unpaid_time_off_hours (anyOf 1)numberAlternativeThe total unpaid time off hours for the pay period.
total_unpaid_time_off_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unpaid_break_hours_by_entryJSONOptional
unpaid_break_hours_by_entry (anyOf 1)numberAlternativeThe map of time entry to unpaidBreakHours in seconds
unpaid_break_hours_by_entry (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a specific time card — response body — summary hours worked by job code item

Retrieve a specific time card — response body — summary hours worked by job code item

FieldTypePresenceDescription and constraints
$objectRoot
hours_workedJSONOptional
hours_worked (anyOf 1)numberAlternativeThe total hours worked for the job codes.
hours_worked (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
job_codes_idarrayOptionalList of job code ids that this summary is tracking hours for.
job_codes_id[]stringEach item

Retrieve a specific time card — response body — worker

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

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

Retrieve a specific user — response body — addresses item

FieldTypePresenceDescription and constraints
$objectRoot
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

Retrieve a specific user — response body — emails item

FieldTypePresenceDescription and constraints
$objectRoot
displaystringOptionalThe display value of the email address.
typestringOptionalThe classification of the email.
Known values: HOME, WORK, OTHER
valuestringOptionalA valid email address.

Retrieve a specific user — response body — name

FieldTypePresenceDescription and constraints
$objectRootThe user's name.
family_namestringOptionalThe legal family name of the user, or last name in most Western languages.
formattedstringOptionalThe user's full name.
given_namestringOptionalThe given legal name of the user, or first name in most Western languages.
middle_namestringOptionalThe middle name(s) of the user.
preferred_family_namestringOptionalThe preferred family name, or last name in most Western languages, by the user.
preferred_given_namestringOptionalThe preferred given name, or first name in most Western languages, by the user.

Retrieve a specific user — response body — phone numbers item

FieldTypePresenceDescription and constraints
$objectRoot
displaystringOptionalThe display value of the phone number.
typestringOptionalThe classification of the phone number, pursuant to SCIM RFC 7643 4.1.2.
Known values: HOME, WORK, MOBILE, FAX, OTHER
valuestringOptionalThe canonical global phone number pursuant to RFC3966.

Retrieve a specific user — response body — photos item

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalThe classification of the photo.
Known values: PHOTO, THUMBNAIL
valuestringOptionalThe URL of the photo.

Retrieve a specific worker change — response body — changed by

FieldTypePresenceDescription and constraints
$objectRootThe actor as the current Worker DTO. Returned only when expand=changed_by is requested.

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

Retrieve a specific worker change — response body — changes item

FieldTypePresenceDescription and constraints
$objectRoot
display_typestringRequired within parentVISIBLE or REDACTED. REDACTED means the caller's role lacks permission to read this field; from_value/to_value are null but the entry still appears so consumers know a change occurred.
Known values: VISIBLE, REDACTED
field_display_namestringRequired within parentUI label for the field (English).
field_keystringRequired within parentField key in snake_case.
from_valuestringOptionalValue before the change, rendered as a display string (locale- and currency-formatted per the activity-log convention). Null when display_type is REDACTED. Typed JSON values are tracked as a future addition; consult value_type to interpret the rendering.
to_valuestringOptionalValue after the change, rendered as a display string. Null when display_type is REDACTED. See from_value for notes on typed-value plans.
value_typestringRequired within parentThe underlying value type of this field. Populated regardless of display_type so consumers can interpret from_value / to_value or anticipate a future typed representation.
Known values: STRING, NUMBER, BOOLEAN, DATE, DATETIME, CURRENCY, ENUM, REFERENCE

Retrieve a specific worker change — response body — worker

FieldTypePresenceDescription and constraints
$objectRootThe affected worker as the current Worker DTO. Returned only when expand=worker is requested. Includes terminated employees.

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

Retrieve a specific worker — response body — business partners item

FieldTypePresenceDescription and constraints
$objectRoot
business_partner_groupobjectOptionalBusiness partner group the business partner is a part of

Expandable field
business_partner_group.created_atstringRequired within parentRecord creation date
business_partner_group.default_business_partnerModelOptionalExpand Retrieve a specific worker — response body — manager
Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.

Expandable field
business_partner_group.default_business_partner_idstringOptionalId of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.
business_partner_group.domainstringOptionalType of business partner group
Known values: HR, IT, FINANCE, RECRUITING, OTHER
business_partner_group.idstringRequired within parentIdentifier field
business_partner_group.namestringRequired within parentName used to identify business partner group
business_partner_group.updated_atstringRequired within parentRecord update date
business_partner_group_idstringRequired within parentIdentifier of business partner group the business parter is a part of
client_groupModelOptionalExpand Create a new business partner — response body — client group
client_group_idstringOptionalIdentifier of group of workers associated with the business partner
client_group_member_countJSONOptional
client_group_member_count (anyOf 1)integerAlternativeNumber of workers associated with the business partner
client_group_member_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific worker — response body — manager
Worker who is the business partner

Expandable field
worker_idstringRequired within parentIdentifier of worker who is the business partner

Referenced models: Retrieve a specific worker — response body — manager, Create a new business partner — response body — client group

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.