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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The Rippling worker associated with this external app account. Expanding this field requires both `app-users.read` and `workers.read` scopes. Expandable field |
business_partners | array | Optional | Worker'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[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
business_partners_id[] | string | Each item | |
citizenship | string | Optional | The 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 |
compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
compensation_grade.label | string | Optional | The compensation grade's label. |
compensation_id | string | Optional | The compensation package for the worker. |
country | string | Optional | The 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_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
date_of_birth | string | Optional | The worker's date of birth. |
department | Model | Optional | Expand Retrieve a specific worker — response body — department |
department_id | string | Optional | The worker's assigned department. |
employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
employment_type_id | string | Optional | The worker's employment type. |
end_date | string | Optional | The end date of the worker. |
ethnicity | string | Optional | The 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 |
gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
id | string | Required within parent | Identifier field |
is_manager | boolean | Optional | Whether the worker is a manager |
job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
job_function.created_at | string | Required within parent | Record creation date |
job_function.id | string | Required within parent | Identifier field |
job_function.name | string | Optional | Displayed name of the job function |
job_function.updated_at | string | Required within parent | Record update date |
job_function_id | string | Optional | ID of the worker's job function. |
legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
legal_entity_id | string | Optional | The worker's associated legal entity. |
level | Model | Optional | Expand Retrieve a specific worker — response body — level |
level_id | string | Optional | The level of the worker. |
location | object | Optional | The 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.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
manager_id | string | Optional | The worker's manager. |
number | JSON | Optional | |
number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
personal_email | string | Optional | The worker's associated personal email address. |
race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
start_date | string | Optional | The start date of the worker. |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
teams | array | Optional | The worker's assigned teams. Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | The worker's assigned teams. |
teams_id[] | string | Each item | |
termination_details | object | Optional | The details of the worker's termination, if applicable. |
termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
title | string | Optional | The worker's title. |
title_effective_date | string | Optional | Title effective date |
updated_at | string | Required within parent | Record update date |
user | Model | Optional | Expand Retrieve a specific worker — response body — user |
user_id | string | Optional | The worker's associated user. |
work_email | string | Optional | The worker's associated work email address. |
work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
work_schedule.* | Model | Additional keys | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amortization_status | string | Optional | Amortization state. Null when not set. Known values: NOT_STARTED, IN_PROGRESS, COMPLETED, ERROR |
amortized | boolean | Optional | Whether this line is amortized. |
amount | object | Optional | Amount of this split, in the merchant currency. The `value` is a decimal string. |
amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
amount.value | JSON | Optional | |
amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
category_id | string | Optional | ID 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_name | string | Optional | Name of the spend category. |
dimension_choices | object | Optional | Selected dimension values, keyed by dimension ID. Includes department and work location. Additional keys: see wildcard field |
dimension_choices.* | Model | Additional keys | Expand Retrieve a specific bill — response body — line items item dimension choices value |
discount | string | Optional | Discount on the item as a percentage (`10.00` means 10%), as a decimal string. Null when not set. |
end_date | string | Optional | Amortization end date. Null when not set. |
gl_amortization_schedule | string | Optional | ID of the amortization schedule in the connected accounting integration. No public API is currently available to retrieve it. Null when not set. |
gl_amortization_template | string | Optional | ID of the amortization template in the connected accounting integration. No public API is currently available to retrieve it. Null when not set. |
gl_billable | string | Optional | Whether 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_customer | string | Optional | ID of the customer record in the connected accounting integration. No public Rippling API is currently available to retrieve this accounting customer. |
gl_tax_code | string | Optional | Rippling ID of the tax code synced from the connected accounting integration. No public API is currently available to retrieve it. Null when not set. |
memo | string | Optional | Memo entered on this split. |
prepaid_account | string | Optional | ID of the prepaid account in the connected accounting integration. No public API is currently available to retrieve it. Null when not set. |
price | object | Optional | Unit price, in the merchant currency. The `value` is a decimal string. Null when not set. |
price.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
price.value | JSON | Optional | |
price.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
price.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity | string | Optional | Item quantity, as a decimal string. Null when not set. |
quantity_unit_of_measure | string | Optional | Unit for quantity, such as tons or seats. Null when quantity is not set. |
start_date | string | Optional | Amortization start date. Null when not set. |
tax_amount | object | Optional | Tax amount entered on the line, in the merchant currency. The `value` is a decimal string. Null when not set. |
tax_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
tax_amount.value | JSON | Optional | |
tax_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
tax_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tax_code_display_alias | string | Optional | Display name of the tax code. Null when not set. |
term | string | Optional | Term length, as a decimal string. Null when not set. |
term_unit_of_measure | string | Optional | Unit for term: YEARS, QUARTERS, MONTHS, WEEKS, or DAYS. Null when term is not set. Known values: YEARS, QUARTERS, MONTHS, WEEKS, DAYS |
total_amortized_amount | object | Optional | Amount amortized so far, in the company's headquarters currency. The `value` is a decimal string. Null when not set. |
total_amortized_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
total_amortized_amount.value | JSON | Optional | |
total_amortized_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
total_amortized_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Finance transaction attachment with recorded upload details. |
file_name | string | Optional | Original file name, when recorded. |
uploaded_at | string | Optional | When the attachment was uploaded, as an ISO 8601 date-time in UTC, when recorded. |
uploaded_by_id | string | Optional | ID of the worker who uploaded the attachment. Use it with `/workers/{id}/`. |
url | string | Required within parent | URL for accessing the file. |
Retrieve a specific bill — response body — line items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amortized | boolean | Optional | Whether this line is amortized. |
amount | object | Optional | Amount of this split, in the merchant currency. The `value` is a decimal string. |
amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
amount.value | JSON | Optional | |
amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
category_id | string | Optional | ID 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_name | string | Optional | Name of the finance category. |
dimension_choices | object | Optional | Selected dimension values, keyed by dimension ID. Includes department and work location. Additional keys: see wildcard field |
dimension_choices.* | Model | Additional keys | Expand Retrieve a specific bill — response body — line items item dimension choices value |
end_date | string | Optional | End of the amortization period (YYYY-MM-DD). |
gl_amortization_schedule | object | Optional | ERP amortization schedule associated with this line. |
gl_amortization_schedule.accounting_integration_id | string | Optional | Rippling ID of the accounting integration that owns this object. |
gl_amortization_schedule.amortization_period | JSON | Optional | |
gl_amortization_schedule.amortization_period (anyOf 1) | integer | Alternative | Number of amortization periods. |
gl_amortization_schedule.amortization_period (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
gl_amortization_schedule.end_date | string | Optional | End 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_id | string | Optional | Object ID in the connected accounting system. |
gl_amortization_schedule.gl_object_type | string | Optional | Type 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.name | string | Optional | Accounting object name. |
gl_amortization_schedule.start_date | string | Optional | Start 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.status | string | Optional | ERP 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_amount | JSON | Optional | |
gl_amortization_schedule.total_amortized_amount (anyOf 1) | number | Alternative | Amount 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
gl_amortization_schedule.total_amount | JSON | Optional | |
gl_amortization_schedule.total_amount (anyOf 1) | number | Alternative | Total 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
gl_amortization_template | object | Optional | ERP amortization template for this line. |
gl_amortization_template.accounting_integration_id | string | Optional | Rippling ID of the accounting integration that owns this object. |
gl_amortization_template.gl_object_id | string | Optional | Object ID in the connected accounting system. |
gl_amortization_template.gl_object_type | string | Optional | Type 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.name | string | Optional | Accounting object name. |
gl_billable | string | Optional | Whether 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_customer | string | Optional | ID of the customer record in the connected accounting integration. No public Rippling API is currently available to retrieve this accounting customer. |
gl_tax_code | string | Optional | Rippling ID of the accounting tax code. |
id | string | Optional | Unique identifier of this line item. Null for older line items that have not been assigned one yet. |
memo | string | Optional | Memo entered on this split. |
prepaid_account | object | Optional | Prepaid asset account for Rippling-managed amortization. |
prepaid_account.account_id | string | Optional | Account ID in the connected accounting system. |
prepaid_account.code | string | Optional | Account code. |
prepaid_account.name | string | Optional | Account name. |
prepaid_account.required_custom_dimensions | array | Optional | IDs of custom dimensions required by this account. |
prepaid_account.required_custom_dimensions[] | string | Each item | |
prepaid_account.requires_department | boolean | Optional | Whether this account requires a department. |
prepaid_account.requires_work_location | boolean | Optional | Whether this account requires a work location. |
prepaid_account.type | string | Optional | Accounting 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_date | string | Optional | Start of the amortization period (YYYY-MM-DD). |
tax_amount | object | Optional | Total tax amount for this line in the merchant currency. |
tax_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
tax_amount.value | JSON | Optional | |
tax_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
tax_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dimension_name | string | Optional | Name of the dimension, such as Department. |
label | string | Optional | Display name of the selected dimension value. |
value | string | Optional | ID of the selected dimension value. |
Retrieve a specific bill — response body — submitter
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Submitting bill manager. Expand with `bills.read` and `workers.read`. Expandable field |
business_partners | array | Optional | Worker'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[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
business_partners_id[] | string | Each item | |
citizenship | string | Optional | The 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 |
compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
compensation_grade.label | string | Optional | The compensation grade's label. |
compensation_id | string | Optional | The compensation package for the worker. |
country | string | Optional | The 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_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
date_of_birth | string | Optional | The worker's date of birth. |
department | Model | Optional | Expand Retrieve a specific worker — response body — department |
department_id | string | Optional | The worker's assigned department. |
employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
employment_type_id | string | Optional | The worker's employment type. |
end_date | string | Optional | The end date of the worker. |
ethnicity | string | Optional | The 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 |
gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
id | string | Required within parent | Identifier field |
is_manager | boolean | Optional | Whether the worker is a manager |
job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
job_function.created_at | string | Required within parent | Record creation date |
job_function.id | string | Required within parent | Identifier field |
job_function.name | string | Optional | Displayed name of the job function |
job_function.updated_at | string | Required within parent | Record update date |
job_function_id | string | Optional | ID of the worker's job function. |
legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
legal_entity_id | string | Optional | The worker's associated legal entity. |
level | Model | Optional | Expand Retrieve a specific worker — response body — level |
level_id | string | Optional | The level of the worker. |
location | object | Optional | The 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.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
manager_id | string | Optional | The worker's manager. |
number | JSON | Optional | |
number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
personal_email | string | Optional | The worker's associated personal email address. |
race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
start_date | string | Optional | The start date of the worker. |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
teams | array | Optional | The worker's assigned teams. Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | The worker's assigned teams. |
teams_id[] | string | Each item | |
termination_details | object | Optional | The details of the worker's termination, if applicable. |
termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
title | string | Optional | The worker's title. |
title_effective_date | string | Optional | Title effective date |
updated_at | string | Required within parent | Record update date |
user | Model | Optional | Expand Retrieve a specific worker — response body — user |
user_id | string | Optional | The worker's associated user. |
work_email | string | Optional | The worker's associated work email address. |
work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
work_schedule.* | Model | Additional keys | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Vendor details. Expand with `bills.read` and `finance-vendors.read`. Expandable field |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_archived | boolean | Optional | Whether the vendor is archived. Archived vendors remain available for historical references. |
logo | string | Optional | URL of the vendor's logo. Null when no logo is available. |
name | string | Optional | Canonical name of the Finance vendor. Name eq, ne, and in filters also match alternate names. |
updated_at | string | Required within parent | Record update date |
Retrieve a specific bill — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker details. Expand with `bills.read` and `workers.read`. Expandable field |
business_partners | array | Optional | Worker'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[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
business_partners_id[] | string | Each item | |
citizenship | string | Optional | The 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 |
compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
compensation_grade.label | string | Optional | The compensation grade's label. |
compensation_id | string | Optional | The compensation package for the worker. |
country | string | Optional | The 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_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
date_of_birth | string | Optional | The worker's date of birth. |
department | Model | Optional | Expand Retrieve a specific worker — response body — department |
department_id | string | Optional | The worker's assigned department. |
employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
employment_type_id | string | Optional | The worker's employment type. |
end_date | string | Optional | The end date of the worker. |
ethnicity | string | Optional | The 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 |
gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
id | string | Required within parent | Identifier field |
is_manager | boolean | Optional | Whether the worker is a manager |
job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
job_function.created_at | string | Required within parent | Record creation date |
job_function.id | string | Required within parent | Identifier field |
job_function.name | string | Optional | Displayed name of the job function |
job_function.updated_at | string | Required within parent | Record update date |
job_function_id | string | Optional | ID of the worker's job function. |
legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
legal_entity_id | string | Optional | The worker's associated legal entity. |
level | Model | Optional | Expand Retrieve a specific worker — response body — level |
level_id | string | Optional | The level of the worker. |
location | object | Optional | The 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.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
manager_id | string | Optional | The worker's manager. |
number | JSON | Optional | |
number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
personal_email | string | Optional | The worker's associated personal email address. |
race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
start_date | string | Optional | The start date of the worker. |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
teams | array | Optional | The worker's assigned teams. Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | The worker's assigned teams. |
teams_id[] | string | Each item | |
termination_details | object | Optional | The details of the worker's termination, if applicable. |
termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
title | string | Optional | The worker's title. |
title_effective_date | string | Optional | Title effective date |
updated_at | string | Required within parent | Record update date |
user | Model | Optional | Expand Retrieve a specific worker — response body — user |
user_id | string | Optional | The worker's associated user. |
work_email | string | Optional | The worker's associated work email address. |
work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
work_schedule.* | Model | Additional keys | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The break policy this break type belongs to. Use ?expand=policy to inline the full policy object. Expandable field |
country_code | string | Optional | ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB'). |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_default | boolean | Optional | Whether this is a system-seeded default policy (true) or a custom policy created by an admin (false). |
name | string | Required within parent | The 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_at | string | Required within parent | Record update date |
Retrieve a specific card transaction — response body — vendor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Vendor details. Expand with `card-transactions.read` and `finance-vendors.read`. Expandable field |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_archived | boolean | Optional | Whether the vendor is archived. Archived vendors remain available for historical references. |
logo | string | Optional | URL of the vendor's logo. Null when no logo is available. |
name | string | Optional | Canonical name of the Finance vendor. Name eq, ne, and in filters also match alternate names. |
updated_at | string | Required within parent | Record update date |
Retrieve a specific card transaction — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker details. Expand with `card-transactions.read` and `workers.read`. Expandable field |
business_partners | array | Optional | Worker'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[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
business_partners_id[] | string | Each item | |
citizenship | string | Optional | The 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 |
compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
compensation_grade.label | string | Optional | The compensation grade's label. |
compensation_id | string | Optional | The compensation package for the worker. |
country | string | Optional | The 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_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
date_of_birth | string | Optional | The worker's date of birth. |
department | Model | Optional | Expand Retrieve a specific worker — response body — department |
department_id | string | Optional | The worker's assigned department. |
employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
employment_type_id | string | Optional | The worker's employment type. |
end_date | string | Optional | The end date of the worker. |
ethnicity | string | Optional | The 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 |
gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
id | string | Required within parent | Identifier field |
is_manager | boolean | Optional | Whether the worker is a manager |
job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
job_function.created_at | string | Required within parent | Record creation date |
job_function.id | string | Required within parent | Identifier field |
job_function.name | string | Optional | Displayed name of the job function |
job_function.updated_at | string | Required within parent | Record update date |
job_function_id | string | Optional | ID of the worker's job function. |
legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
legal_entity_id | string | Optional | The worker's associated legal entity. |
level | Model | Optional | Expand Retrieve a specific worker — response body — level |
level_id | string | Optional | The level of the worker. |
location | object | Optional | The 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.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
manager_id | string | Optional | The worker's manager. |
number | JSON | Optional | |
number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
personal_email | string | Optional | The worker's associated personal email address. |
race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
start_date | string | Optional | The start date of the worker. |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
teams | array | Optional | The worker's assigned teams. Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | The worker's assigned teams. |
teams_id[] | string | Each item | |
termination_details | object | Optional | The details of the worker's termination, if applicable. |
termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
title | string | Optional | The worker's title. |
title_effective_date | string | Optional | Title effective date |
updated_at | string | Required within parent | Record update date |
user | Model | Optional | Expand Retrieve a specific worker — response body — user |
user_id | string | Optional | The worker's associated user. |
work_email | string | Optional | The worker's associated work email address. |
work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
work_schedule.* | Model | Additional keys | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The mailing address of the entity. |
country | string | Optional | The 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 |
formatted | string | Optional | The formatted mailing address. |
locality | string | Optional | The city or locality component. |
postal_code | string | Optional | The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2. |
region | string | Optional | The state or region component, pursuant to SCIM RFC 7643 4.1.2. |
street_address | string | Optional | The 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.. |
type | string | Optional | The classification of the address. Known values: HOME, WORK, OTHER |
Retrieve a specific company legal entity — response body — physical address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The physical address of the entity, if it differs from the mailing address. |
country | string | Optional | The 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 |
formatted | string | Optional | The formatted mailing address. |
locality | string | Optional | The city or locality component. |
postal_code | string | Optional | The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2. |
region | string | Optional | The state or region component, pursuant to SCIM RFC 7643 4.1.2. |
street_address | string | Optional | The 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.. |
type | string | Optional | The classification of the address. Known values: HOME, WORK, OTHER |
Retrieve a specific compensation bands detail — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker associated with compensation bands Expandable field |
business_partners | array | Optional | Worker'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[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
business_partners_id[] | string | Each item | |
citizenship | string | Optional | The 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 |
compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
compensation_grade.label | string | Optional | The compensation grade's label. |
compensation_id | string | Optional | The compensation package for the worker. |
country | string | Optional | The 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_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
date_of_birth | string | Optional | The worker's date of birth. |
department | Model | Optional | Expand Retrieve a specific worker — response body — department |
department_id | string | Optional | The worker's assigned department. |
employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
employment_type_id | string | Optional | The worker's employment type. |
end_date | string | Optional | The end date of the worker. |
ethnicity | string | Optional | The 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 |
gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
id | string | Required within parent | Identifier field |
is_manager | boolean | Optional | Whether the worker is a manager |
job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
job_function.created_at | string | Required within parent | Record creation date |
job_function.id | string | Required within parent | Identifier field |
job_function.name | string | Optional | Displayed name of the job function |
job_function.updated_at | string | Required within parent | Record update date |
job_function_id | string | Optional | ID of the worker's job function. |
legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
legal_entity_id | string | Optional | The worker's associated legal entity. |
level | Model | Optional | Expand Retrieve a specific worker — response body — level |
level_id | string | Optional | The level of the worker. |
location | object | Optional | The 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.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
manager_id | string | Optional | The worker's manager. |
number | JSON | Optional | |
number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
personal_email | string | Optional | The worker's associated personal email address. |
race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
start_date | string | Optional | The start date of the worker. |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
teams | array | Optional | The worker's assigned teams. Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | The worker's assigned teams. |
teams_id[] | string | Each item | |
termination_details | object | Optional | The details of the worker's termination, if applicable. |
termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
title | string | Optional | The worker's title. |
title_effective_date | string | Optional | Title effective date |
updated_at | string | Required within parent | Record update date |
user | Model | Optional | Expand Retrieve a specific worker — response body — user |
user_id | string | Optional | The worker's associated user. |
work_email | string | Optional | The worker's associated work email address. |
work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
work_schedule.* | Model | Additional keys | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker's details. Expandable field |
business_partners | array | Optional | Worker'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[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
business_partners_id[] | string | Each item | |
citizenship | string | Optional | The 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 |
compensation | Model | Optional | Expand List compensations — response body — results item The compensation package for the worker. Expandable field |
compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
compensation_grade.label | string | Optional | The compensation grade's label. |
compensation_id | string | Optional | The compensation package for the worker. |
country | string | Optional | The 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_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
date_of_birth | string | Optional | The worker's date of birth. |
department | Model | Optional | Expand Retrieve a specific worker — response body — department |
department_id | string | Optional | The worker's assigned department. |
employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
employment_type_id | string | Optional | The worker's employment type. |
end_date | string | Optional | The end date of the worker. |
ethnicity | string | Optional | The 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 |
gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
id | string | Required within parent | Identifier field |
is_manager | boolean | Optional | Whether the worker is a manager |
job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
job_function.created_at | string | Required within parent | Record creation date |
job_function.id | string | Required within parent | Identifier field |
job_function.name | string | Optional | Displayed name of the job function |
job_function.updated_at | string | Required within parent | Record update date |
job_function_id | string | Optional | ID of the worker's job function. |
legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
legal_entity_id | string | Optional | The worker's associated legal entity. |
level | Model | Optional | Expand Retrieve a specific worker — response body — level |
level_id | string | Optional | The level of the worker. |
location | object | Optional | The 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.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
manager_id | string | Optional | The worker's manager. |
number | JSON | Optional | |
number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
personal_email | string | Optional | The worker's associated personal email address. |
race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
start_date | string | Optional | The start date of the worker. |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
teams | array | Optional | The worker's assigned teams. Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | The worker's assigned teams. |
teams_id[] | string | Each item | |
termination_details | object | Optional | The details of the worker's termination, if applicable. |
termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
title | string | Optional | The worker's title. |
title_effective_date | string | Optional | Title effective date |
updated_at | string | Required within parent | Record update date |
user | Model | Optional | Expand Retrieve a specific worker — response body — user |
user_id | string | Optional | The worker's associated user. |
work_email | string | Optional | The worker's associated work email address. |
work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
work_schedule.* | Model | Additional keys | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: see wildcard field |
created_at | string | Required within parent | Record creation date |
created_by | object | Optional | |
created_by.display_value | string | Optional | The display name of the role. |
created_by.id | string | Optional | The unique identifier of the role. |
created_by.image | string | Optional | The URL of the role's profile image. |
external_id | string | Optional | The external id of the custom object datarow |
id | string | Required within parent | Identifier field |
last_modified_by | object | Optional | |
last_modified_by.display_value | string | Optional | The display name of the role. |
last_modified_by.id | string | Optional | The unique identifier of the role. |
last_modified_by.image | string | Optional | The URL of the role's profile image. |
name | string | Required within parent | The name of the custom object datarow |
owner_role | object | Optional | |
owner_role.display_value | string | Optional | The display name of the role. |
owner_role.id | string | Optional | The unique identifier of the role. |
owner_role.image | string | Optional | The URL of the role's profile image. |
system_updated_at | string | Optional | The timestamp when the record was last updated by the system. |
updated_at | string | Required within parent | Record update date |
$.* | JSON | Additional keys |
Retrieve a specific device order — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker the order is for. Expandable field |
business_partners | array | Optional | Worker'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[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
business_partners_id[] | string | Each item | |
citizenship | string | Optional | The 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 |
compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
compensation_grade.label | string | Optional | The compensation grade's label. |
compensation_id | string | Optional | The compensation package for the worker. |
country | string | Optional | The 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_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
date_of_birth | string | Optional | The worker's date of birth. |
department | Model | Optional | Expand Retrieve a specific worker — response body — department |
department_id | string | Optional | The worker's assigned department. |
employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
employment_type_id | string | Optional | The worker's employment type. |
end_date | string | Optional | The end date of the worker. |
ethnicity | string | Optional | The 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 |
gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
id | string | Required within parent | Identifier field |
is_manager | boolean | Optional | Whether the worker is a manager |
job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
job_function.created_at | string | Required within parent | Record creation date |
job_function.id | string | Required within parent | Identifier field |
job_function.name | string | Optional | Displayed name of the job function |
job_function.updated_at | string | Required within parent | Record update date |
job_function_id | string | Optional | ID of the worker's job function. |
legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
legal_entity_id | string | Optional | The worker's associated legal entity. |
level | Model | Optional | Expand Retrieve a specific worker — response body — level |
level_id | string | Optional | The level of the worker. |
location | object | Optional | The 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.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
manager_id | string | Optional | The worker's manager. |
number | JSON | Optional | |
number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
personal_email | string | Optional | The worker's associated personal email address. |
race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
start_date | string | Optional | The start date of the worker. |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
teams | array | Optional | The worker's assigned teams. Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | The worker's assigned teams. |
teams_id[] | string | Each item | |
termination_details | object | Optional | The details of the worker's termination, if applicable. |
termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
title | string | Optional | The worker's title. |
title_effective_date | string | Optional | Title effective date |
updated_at | string | Required within parent | Record update date |
user | Model | Optional | Expand Retrieve a specific worker — response body — user |
user_id | string | Optional | The worker's associated user. |
work_email | string | Optional | The worker's associated work email address. |
work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
work_schedule.* | Model | Additional keys | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action_type | string | Optional | The 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_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
queued_at | string | Optional | When the action was queued. |
state | string | Optional | The current state of the pending action (e.g. QUEUED, WAITING_FOR_USER_ACTION). |
updated_at | string | Required within parent | Record update date |
Retrieve a specific device — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker this device is currently assigned to. Expandable field |
business_partners | array | Optional | Worker'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[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
business_partners_id[] | string | Each item | |
citizenship | string | Optional | The 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 |
compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
compensation_grade.label | string | Optional | The compensation grade's label. |
compensation_id | string | Optional | The compensation package for the worker. |
country | string | Optional | The 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_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
date_of_birth | string | Optional | The worker's date of birth. |
department | Model | Optional | Expand Retrieve a specific worker — response body — department |
department_id | string | Optional | The worker's assigned department. |
employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
employment_type_id | string | Optional | The worker's employment type. |
end_date | string | Optional | The end date of the worker. |
ethnicity | string | Optional | The 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 |
gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
id | string | Required within parent | Identifier field |
is_manager | boolean | Optional | Whether the worker is a manager |
job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
job_function.created_at | string | Required within parent | Record creation date |
job_function.id | string | Required within parent | Identifier field |
job_function.name | string | Optional | Displayed name of the job function |
job_function.updated_at | string | Required within parent | Record update date |
job_function_id | string | Optional | ID of the worker's job function. |
legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
legal_entity_id | string | Optional | The worker's associated legal entity. |
level | Model | Optional | Expand Retrieve a specific worker — response body — level |
level_id | string | Optional | The level of the worker. |
location | object | Optional | The 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.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
manager_id | string | Optional | The worker's manager. |
number | JSON | Optional | |
number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
personal_email | string | Optional | The worker's associated personal email address. |
race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
start_date | string | Optional | The start date of the worker. |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
teams | array | Optional | The worker's assigned teams. Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | The worker's assigned teams. |
teams_id[] | string | Each item | |
termination_details | object | Optional | The details of the worker's termination, if applicable. |
termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
title | string | Optional | The worker's title. |
title_effective_date | string | Optional | Title effective date |
updated_at | string | Required within parent | Record update date |
user | Model | Optional | Expand Retrieve a specific worker — response body — user |
user_id | string | Optional | The worker's associated user. |
work_email | string | Optional | The worker's associated work email address. |
work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
work_schedule.* | Model | Additional keys | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Compensation data synched from worker compensation |
base_pay | object | Optional | Annual base pay for the headcount position |
base_pay.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
base_pay.value | JSON | Optional | |
base_pay.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
base_pay.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
bonus | object | Optional | Annual bonus for the headcount position |
bonus.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
bonus.value | JSON | Optional | |
bonus.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
bonus.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
commission | object | Optional | Annual on target commission for the headcount position |
commission.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
commission.value | JSON | Optional | |
commission.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
commission.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tax_and_benefits | object | Optional | Annual total taxes and benefits compensation for this headcount position |
tax_and_benefits.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
tax_and_benefits.value | JSON | Optional | |
tax_and_benefits.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
tax_and_benefits.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_cash | object | Optional | Annual total cash compensation for the headcount position |
total_cash.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
total_cash.value | JSON | Optional | |
total_cash.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
total_cash.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_equity | object | Optional | Annual total equity compensation for the headcount position |
total_equity.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
total_equity.value | JSON | Optional | |
total_equity.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
total_equity.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a specific headcount position — response body — backfill for
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker for whom this headcount position was requested as a backfill Expandable field |
business_partners | array | Optional | Worker'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[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
business_partners_id[] | string | Each item | |
citizenship | string | Optional | The 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 |
compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
compensation_grade.label | string | Optional | The compensation grade's label. |
compensation_id | string | Optional | The compensation package for the worker. |
country | string | Optional | The 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_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
date_of_birth | string | Optional | The worker's date of birth. |
department | Model | Optional | Expand Retrieve a specific worker — response body — department |
department_id | string | Optional | The worker's assigned department. |
employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
employment_type_id | string | Optional | The worker's employment type. |
end_date | string | Optional | The end date of the worker. |
ethnicity | string | Optional | The 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 |
gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
id | string | Required within parent | Identifier field |
is_manager | boolean | Optional | Whether the worker is a manager |
job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
job_function.created_at | string | Required within parent | Record creation date |
job_function.id | string | Required within parent | Identifier field |
job_function.name | string | Optional | Displayed name of the job function |
job_function.updated_at | string | Required within parent | Record update date |
job_function_id | string | Optional | ID of the worker's job function. |
legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
legal_entity_id | string | Optional | The worker's associated legal entity. |
level | Model | Optional | Expand Retrieve a specific worker — response body — level |
level_id | string | Optional | The level of the worker. |
location | object | Optional | The 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.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
manager_id | string | Optional | The worker's manager. |
number | JSON | Optional | |
number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
personal_email | string | Optional | The worker's associated personal email address. |
race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
start_date | string | Optional | The start date of the worker. |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
teams | array | Optional | The worker's assigned teams. Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | The worker's assigned teams. |
teams_id[] | string | Each item | |
termination_details | object | Optional | The details of the worker's termination, if applicable. |
termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
title | string | Optional | The worker's title. |
title_effective_date | string | Optional | Title effective date |
updated_at | string | Required within parent | Record update date |
user | Model | Optional | Expand Retrieve a specific worker — response body — user |
user_id | string | Optional | The worker's associated user. |
work_email | string | Optional | The worker's associated work email address. |
work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
work_schedule.* | Model | Additional keys | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Compensation data defined through comp band |
base_pay | object | Optional | Annual base pay for the headcount position |
base_pay.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
base_pay.value | JSON | Optional | |
base_pay.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
base_pay.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
bonus | object | Optional | Annual bonus for the headcount position |
bonus.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
bonus.value | JSON | Optional | |
bonus.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
bonus.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
commission | object | Optional | Annual on target commission for the headcount position |
commission.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
commission.value | JSON | Optional | |
commission.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
commission.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tax_and_benefits | object | Optional | Annual total taxes and benefits compensation for this headcount position |
tax_and_benefits.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
tax_and_benefits.value | JSON | Optional | |
tax_and_benefits.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
tax_and_benefits.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_cash | object | Optional | Annual total cash compensation for the headcount position |
total_cash.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
total_cash.value | JSON | Optional | |
total_cash.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
total_cash.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_equity | object | Optional | Annual total equity compensation for the headcount position |
total_equity.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
total_equity.value | JSON | Optional | |
total_equity.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
total_equity.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a specific headcount position — response body — department
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Department the headcount belongs to Expandable field |
created_at | string | Required within parent | Record creation date |
department_hierarchy | array | Optional | List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order. Expandable field |
department_hierarchy[] | Model | Each item | Expand Update a department — response body — parent |
department_hierarchy_id | array | Optional | The identifier of departments in the department hierarchy ordered from parent department to child department. |
department_hierarchy_id[] | string | Each item | |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the department. |
parent | Model | Optional | Expand Update a department — response body — parent The parent department. Expandable field |
parent_id | string | Optional | The parent department. |
reference_code | string | Optional | Reference code of the department. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a department — response body — parent
Retrieve a specific headcount position — response body — employment type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment type the headcount is assigned to Expandable field |
amount_worked | string | Optional | The 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_period | string | Optional | The 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_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
label | string | Required within parent | The display label of the employment type. |
name | string | Optional | The name of the employment type for non-custom employment types. |
type | string | Optional | The 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_at | string | Required within parent | Record update date |