Skip to content

Rippling: Rest API schemas (part 5)

24 Rippling schemas with complete fields and constraints.

← Rest API operations · All schemas

Retrieve a specific app user — response body — worker

FieldTypePresenceDescription and constraints
$objectRootThe Rippling worker associated with this external app account. Expanding this field requires both `app-users.read` and `workers.read` scopes.

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 bill payment — response body — line items item

FieldTypePresenceDescription and constraints
$objectRoot
amortization_statusstringOptionalAmortization state. Null when not set.
Known values: NOT_STARTED, IN_PROGRESS, COMPLETED, ERROR
amortizedbooleanOptionalWhether this line is amortized.
amountobjectOptionalAmount of this split, in the merchant currency. 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]+)?$
category_idstringOptionalID of the Spend category assigned to this split. No public API is currently available to retrieve this category; its name is in `category_name`.
category_namestringOptionalName of the spend category.
dimension_choicesobjectOptionalSelected dimension values, keyed by dimension ID. Includes department and work location.
Additional keys: see wildcard field
dimension_choices.*ModelAdditional keysExpand Retrieve a specific bill — response body — line items item dimension choices value
discountstringOptionalDiscount on the item as a percentage (`10.00` means 10%), as a decimal string. Null when not set.
end_datestringOptionalAmortization end date. Null when not set.
gl_amortization_schedulestringOptionalID of the amortization schedule in the connected accounting integration. No public API is currently available to retrieve it. Null when not set.
gl_amortization_templatestringOptionalID of the amortization template in the connected accounting integration. No public API is currently available to retrieve it. Null when not set.
gl_billablestringOptionalWhether this split is billed to `gl_customer` in the accounting system. `BILLABLE` means it is billed, `NOT_BILLABLE` means it is not. Null when not set.
Known values: BILLABLE, NOT_BILLABLE
gl_customerstringOptionalID of the customer record in the connected accounting integration. No public Rippling API is currently available to retrieve this accounting customer.
gl_tax_codestringOptionalRippling ID of the tax code synced from the connected accounting integration. No public API is currently available to retrieve it. Null when not set.
memostringOptionalMemo entered on this split.
prepaid_accountstringOptionalID of the prepaid account in the connected accounting integration. No public API is currently available to retrieve it. Null when not set.
priceobjectOptionalUnit price, in the merchant currency. The `value` is a decimal string. Null when not set.
price.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
price.valueJSONOptional
price.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
price.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantitystringOptionalItem quantity, as a decimal string. Null when not set.
quantity_unit_of_measurestringOptionalUnit for quantity, such as tons or seats. Null when quantity is not set.
start_datestringOptionalAmortization start date. Null when not set.
tax_amountobjectOptionalTax amount entered on the line, in the merchant currency. The `value` is a decimal string. Null when not set.
tax_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
tax_amount.valueJSONOptional
tax_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
tax_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax_code_display_aliasstringOptionalDisplay name of the tax code. Null when not set.
termstringOptionalTerm length, as a decimal string. Null when not set.
term_unit_of_measurestringOptionalUnit for term: YEARS, QUARTERS, MONTHS, WEEKS, or DAYS. Null when term is not set.
Known values: YEARS, QUARTERS, MONTHS, WEEKS, DAYS
total_amortized_amountobjectOptionalAmount amortized so far, in the company's headquarters currency. The `value` is a decimal string. Null when not set.
total_amortized_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
total_amortized_amount.valueJSONOptional
total_amortized_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
total_amortized_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a specific bill — response body — line items item dimension choices value

Retrieve a specific bill — response body — attachments item

FieldTypePresenceDescription and constraints
$objectRootA Finance transaction attachment with recorded upload details.
file_namestringOptionalOriginal file name, when recorded.
uploaded_atstringOptionalWhen the attachment was uploaded, as an ISO 8601 date-time in UTC, when recorded.
uploaded_by_idstringOptionalID of the worker who uploaded the attachment. Use it with `/workers/{id}/`.
urlstringRequired within parentURL for accessing the file.

Retrieve a specific bill — response body — line items item

FieldTypePresenceDescription and constraints
$objectRoot
amortizedbooleanOptionalWhether this line is amortized.
amountobjectOptionalAmount of this split, in the merchant currency. 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]+)?$
category_idstringOptionalID of the Finance category assigned to this split. No public API is currently available to retrieve this category; its name is in `category_name`.
category_namestringOptionalName of the finance category.
dimension_choicesobjectOptionalSelected dimension values, keyed by dimension ID. Includes department and work location.
Additional keys: see wildcard field
dimension_choices.*ModelAdditional keysExpand Retrieve a specific bill — response body — line items item dimension choices value
end_datestringOptionalEnd of the amortization period (YYYY-MM-DD).
gl_amortization_scheduleobjectOptionalERP amortization schedule associated with this line.
gl_amortization_schedule.accounting_integration_idstringOptionalRippling ID of the accounting integration that owns this object.
gl_amortization_schedule.amortization_periodJSONOptional
gl_amortization_schedule.amortization_period (anyOf 1)integerAlternativeNumber of amortization periods.
gl_amortization_schedule.amortization_period (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
gl_amortization_schedule.end_datestringOptionalEnd of the ERP amortization schedule as an ISO 8601 timestamp (for example, 2026-12-31T00:00:00). May omit a timezone offset; an omitted offset does not indicate UTC. Null when not set.
gl_amortization_schedule.gl_object_idstringOptionalObject ID in the connected accounting system.
gl_amortization_schedule.gl_object_typestringOptionalType of object in the connected accounting system: GL_AMORTIZATION_TEMPLATE defines amortization rules; GL_AMORTIZATION_SCHEDULE tracks amortization; GL_AMORTIZATION_SCHEDULE_RECURRENCE is a schedule entry; GL_ACCOUNT is a general ledger account; GL_JOURNAL_ENTRY is a journal entry; GL_POSTING_PERIOD is an accounting period; GL_VENDOR, GL_CUSTOMER, and GL_EMPLOYEE identify a vendor, customer, and employee respectively; GL_SUBSIDIARY identifies a subsidiary. Null when not set.
Known values: GL_AMORTIZATION_TEMPLATE, GL_AMORTIZATION_SCHEDULE, GL_AMORTIZATION_SCHEDULE_RECURRENCE, GL_ACCOUNT, GL_JOURNAL_ENTRY, GL_POSTING_PERIOD, GL_VENDOR, GL_CUSTOMER, GL_EMPLOYEE, GL_SUBSIDIARY
gl_amortization_schedule.namestringOptionalAccounting object name.
gl_amortization_schedule.start_datestringOptionalStart of the ERP amortization schedule as an ISO 8601 timestamp (for example, 2026-01-01T00:00:00). May omit a timezone offset; an omitted offset does not indicate UTC. Null when not set.
gl_amortization_schedule.statusstringOptionalERP amortization schedule status: NOT_STARTED means amortization has not begun; IN_PROGRESS means amortization is underway; COMPLETED means amortization is complete; ON_HOLD means amortization is paused. Null when not set.
Known values: NOT_STARTED, IN_PROGRESS, COMPLETED, ON_HOLD
gl_amortization_schedule.total_amortized_amountJSONOptional
gl_amortization_schedule.total_amortized_amount (anyOf 1)numberAlternativeAmount already amortized as reported by the ERP, in the same currency as total_amount. No currency conversion is applied; the schedule currency code is not available in this response.
gl_amortization_schedule.total_amortized_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
gl_amortization_schedule.total_amountJSONOptional
gl_amortization_schedule.total_amount (anyOf 1)numberAlternativeTotal schedule amount as reported by the ERP, without currency conversion. The schedule currency code is not available in this response.
gl_amortization_schedule.total_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
gl_amortization_templateobjectOptionalERP amortization template for this line.
gl_amortization_template.accounting_integration_idstringOptionalRippling ID of the accounting integration that owns this object.
gl_amortization_template.gl_object_idstringOptionalObject ID in the connected accounting system.
gl_amortization_template.gl_object_typestringOptionalType of object in the connected accounting system: GL_AMORTIZATION_TEMPLATE defines amortization rules; GL_AMORTIZATION_SCHEDULE tracks amortization; GL_AMORTIZATION_SCHEDULE_RECURRENCE is a schedule entry; GL_ACCOUNT is a general ledger account; GL_JOURNAL_ENTRY is a journal entry; GL_POSTING_PERIOD is an accounting period; GL_VENDOR, GL_CUSTOMER, and GL_EMPLOYEE identify a vendor, customer, and employee respectively; GL_SUBSIDIARY identifies a subsidiary. Null when not set.
Known values: GL_AMORTIZATION_TEMPLATE, GL_AMORTIZATION_SCHEDULE, GL_AMORTIZATION_SCHEDULE_RECURRENCE, GL_ACCOUNT, GL_JOURNAL_ENTRY, GL_POSTING_PERIOD, GL_VENDOR, GL_CUSTOMER, GL_EMPLOYEE, GL_SUBSIDIARY
gl_amortization_template.namestringOptionalAccounting object name.
gl_billablestringOptionalWhether this split is billed to `gl_customer` in the accounting system. `BILLABLE` means it is billed, `NOT_BILLABLE` means it is not. Null when not set.
Known values: BILLABLE, NOT_BILLABLE
gl_customerstringOptionalID of the customer record in the connected accounting integration. No public Rippling API is currently available to retrieve this accounting customer.
gl_tax_codestringOptionalRippling ID of the accounting tax code.
idstringOptionalUnique identifier of this line item. Null for older line items that have not been assigned one yet.
memostringOptionalMemo entered on this split.
prepaid_accountobjectOptionalPrepaid asset account for Rippling-managed amortization.
prepaid_account.account_idstringOptionalAccount ID in the connected accounting system.
prepaid_account.codestringOptionalAccount code.
prepaid_account.namestringOptionalAccount name.
prepaid_account.required_custom_dimensionsarrayOptionalIDs of custom dimensions required by this account.
prepaid_account.required_custom_dimensions[]stringEach item
prepaid_account.requires_departmentbooleanOptionalWhether this account requires a department.
prepaid_account.requires_work_locationbooleanOptionalWhether this account requires a work location.
prepaid_account.typestringOptionalAccounting account type: RECEIVABLE for accounts receivable, PAYABLE for accounts payable, EXPENSE for expense accounts, or BANK for bank accounts. Null when not set.
Known values: RECEIVABLE, PAYABLE, EXPENSE, BANK
start_datestringOptionalStart of the amortization period (YYYY-MM-DD).
tax_amountobjectOptionalTotal tax amount for this line in the merchant currency.
tax_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
tax_amount.valueJSONOptional
tax_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
tax_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a specific bill — response body — line items item dimension choices value

Retrieve a specific bill — response body — line items item dimension choices value

FieldTypePresenceDescription and constraints
$objectRoot
dimension_namestringOptionalName of the dimension, such as Department.
labelstringOptionalDisplay name of the selected dimension value.
valuestringOptionalID of the selected dimension value.

Retrieve a specific bill — response body — submitter

FieldTypePresenceDescription and constraints
$objectRootSubmitting bill manager. Expand with `bills.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 bill — response body — vendor

FieldTypePresenceDescription and constraints
$objectRootVendor details. Expand with `bills.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 bill — response body — worker

FieldTypePresenceDescription and constraints
$objectRootWorker details. Expand with `bills.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 break type — response body — policy

FieldTypePresenceDescription and constraints
$objectRootThe break policy this break type belongs to. Use ?expand=policy to inline the full policy object.

Expandable field
country_codestringOptionalISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
is_defaultbooleanOptionalWhether this is a system-seeded default policy (true) or a custom policy created by an admin (false).
namestringRequired within parentThe display name of the break policy. For default policies this is the system-generated label (e.g. 'Default Break policy: All Workers | California'); for custom policies this is the admin-provided description.
updated_atstringRequired within parentRecord update date

Retrieve a specific card transaction — response body — vendor

FieldTypePresenceDescription and constraints
$objectRootVendor details. Expand with `card-transactions.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 card transaction — response body — worker

FieldTypePresenceDescription and constraints
$objectRootWorker details. Expand with `card-transactions.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 company legal entity — response body — mailing address

FieldTypePresenceDescription and constraints
$objectRootThe mailing address of the 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 company legal entity — response body — physical address

FieldTypePresenceDescription and constraints
$objectRootThe physical address of the 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 compensation bands detail — response body — worker

FieldTypePresenceDescription and constraints
$objectRootThe worker associated with compensation bands

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

FieldTypePresenceDescription and constraints
$objectRootThe worker's details.

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 List compensations — response body — results item
The compensation package for the worker.

Expandable field
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, List compensations — response body — results 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 — 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 custom object record — response body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: see wildcard field
created_atstringRequired within parentRecord creation date
created_byobjectOptional
created_by.display_valuestringOptionalThe display name of the role.
created_by.idstringOptionalThe unique identifier of the role.
created_by.imagestringOptionalThe URL of the role's profile image.
external_idstringOptionalThe external id of the custom object datarow
idstringRequired within parentIdentifier field
last_modified_byobjectOptional
last_modified_by.display_valuestringOptionalThe display name of the role.
last_modified_by.idstringOptionalThe unique identifier of the role.
last_modified_by.imagestringOptionalThe URL of the role's profile image.
namestringRequired within parentThe name of the custom object datarow
owner_roleobjectOptional
owner_role.display_valuestringOptionalThe display name of the role.
owner_role.idstringOptionalThe unique identifier of the role.
owner_role.imagestringOptionalThe URL of the role's profile image.
system_updated_atstringOptionalThe timestamp when the record was last updated by the system.
updated_atstringRequired within parentRecord update date
$.*JSONAdditional keys

Retrieve a specific device order — response body — worker

FieldTypePresenceDescription and constraints
$objectRootThe worker the order is for.

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 device — response body — pending actions item

FieldTypePresenceDescription and constraints
$objectRoot
action_typestringOptionalThe type of the pending device action (e.g. LOCK_DEVICE, RESET_PASSWORD).
Known values: ADD_USER_TO_FILEVAULT, ASSIGN_DEVICE, AUTHENTICATE_AGENT, CHANGE_FILEVAULT_RECOVERY_KEY, CHANGE_PASSWORD, CLEAR_PASSCODE, CREATE_RIPPLING_ADMIN, DELETE_LOCAL_ACCOUNT, DEMOTE_ACCOUNT_PERMISSION, DISABLE_FIND_MY, DISABLE_LOST_MODE, DISABLE_REMOTE_DESKTOP, ENABLE_LOST_MODE, ENABLE_REMOTE_DESKTOP, ENFORCE_PASSWORD_POLICY, FORCE_CHECK_IN, FULL_WIPE, GRANT_SECURE_TOKEN, INSTALL_ENROLLMENT_PROFILE, LOCK_DEVICE, LOCK_USER_ACCOUNT, LOST_MODE_GET_LOCATION, LOST_MODE_PLAY_SOUND, PROMOTE_ACCOUNT_PERMISSION, RECOVER_AGENT_VIA_MDM, REINSTALL_AGENT, REINSTALL_ENROLLMENT_PROFILE, REMOVE_OTHER_ENROLLMENT_PROFILES, RESET_PASSWORD, RESTART_DEVICE, ROTATE_FILEVAULT_KEY, SHUTDOWN_DEVICE, SOFT_WIPE, TURN_ON_FILEVAULT, UNASSIGN_DEVICE, UNINSTALL_AGENT, UNINSTALL_ANTIVIRUS, UNINSTALL_MDM, UNLOCK_DEVICE, UNLOCK_USER_ACCOUNT, UPDATE_OS, UNKNOWN
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
queued_atstringOptionalWhen the action was queued.
statestringOptionalThe current state of the pending action (e.g. QUEUED, WAITING_FOR_USER_ACTION).
updated_atstringRequired within parentRecord update date

Retrieve a specific device — response body — worker

FieldTypePresenceDescription and constraints
$objectRootThe worker this device is currently assigned to.

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 — actual compensation

FieldTypePresenceDescription and constraints
$objectRootCompensation data synched from worker compensation
base_payobjectOptionalAnnual base pay for the headcount position
base_pay.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
base_pay.valueJSONOptional
base_pay.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
base_pay.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
bonusobjectOptionalAnnual bonus for the headcount position
bonus.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
bonus.valueJSONOptional
bonus.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
bonus.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
commissionobjectOptionalAnnual on target commission for the headcount position
commission.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
commission.valueJSONOptional
commission.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
commission.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax_and_benefitsobjectOptionalAnnual total taxes and benefits compensation for this headcount position
tax_and_benefits.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
tax_and_benefits.valueJSONOptional
tax_and_benefits.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
tax_and_benefits.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_cashobjectOptionalAnnual total cash compensation for the headcount position
total_cash.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
total_cash.valueJSONOptional
total_cash.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
total_cash.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_equityobjectOptionalAnnual total equity compensation for the headcount position
total_equity.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
total_equity.valueJSONOptional
total_equity.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
total_equity.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a specific headcount position — response body — backfill for

FieldTypePresenceDescription and constraints
$objectRootWorker for whom this headcount position was requested as a backfill

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 — comp band compensation

FieldTypePresenceDescription and constraints
$objectRootCompensation data defined through comp band
base_payobjectOptionalAnnual base pay for the headcount position
base_pay.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
base_pay.valueJSONOptional
base_pay.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
base_pay.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
bonusobjectOptionalAnnual bonus for the headcount position
bonus.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
bonus.valueJSONOptional
bonus.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
bonus.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
commissionobjectOptionalAnnual on target commission for the headcount position
commission.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
commission.valueJSONOptional
commission.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
commission.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax_and_benefitsobjectOptionalAnnual total taxes and benefits compensation for this headcount position
tax_and_benefits.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
tax_and_benefits.valueJSONOptional
tax_and_benefits.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
tax_and_benefits.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_cashobjectOptionalAnnual total cash compensation for the headcount position
total_cash.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
total_cash.valueJSONOptional
total_cash.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
total_cash.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_equityobjectOptionalAnnual total equity compensation for the headcount position
total_equity.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
total_equity.valueJSONOptional
total_equity.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
total_equity.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a specific headcount position — response body — department

FieldTypePresenceDescription and constraints
$objectRootDepartment the headcount belongs to

Expandable field
created_atstringRequired within parentRecord creation date
department_hierarchyarrayOptionalList of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.

Expandable field
department_hierarchy[]ModelEach itemExpand Update a department — response body — parent
department_hierarchy_idarrayOptionalThe identifier of departments in the department hierarchy ordered from parent department to child department.
department_hierarchy_id[]stringEach item
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the department.
parentModelOptionalExpand Update a department — response body — parent
The parent department.

Expandable field
parent_idstringOptionalThe parent department.
reference_codestringOptionalReference code of the department.
updated_atstringRequired within parentRecord update date

Referenced models: Update a department — response body — parent

Retrieve a specific headcount position — response body — employment type

FieldTypePresenceDescription and constraints
$objectRootEmployment type the headcount is assigned to

Expandable field
amount_workedstringOptionalThe amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.
Known values: PART-TIME, FULL-TIME, TEMPORARY
compensation_time_periodstringOptionalThe compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.
Known values: HOURLY, SALARIED
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
labelstringRequired within parentThe display label of the employment type.
namestringOptionalThe name of the employment type for non-custom employment types.
typestringOptionalThe classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.
Known values: CONTRACTOR, EMPLOYEE
updated_atstringRequired within parentRecord update date

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.