Rippling: Rest API schemas (part 6)
37 Rippling schemas with complete fields and constraints.
← Rest API operations · All schemas
Retrieve a specific headcount position — response body — headcount owner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Owner of the headcount 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 — job requisition
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job requisition the headcount is associated with Expandable field |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
name | string | Required within parent | Job requisition name |
status | string | Required within parent | Job requisition status Known values: OPEN, CLOSED, PUBLISHED, DRAFT, ARCHIVED |
updated_at | string | Required within parent | Record update date |
Retrieve a specific headcount position — response body — level
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Level the headcount is assigned to Expandable field |
created_at | string | Required within parent | Record creation date |
description | string | Optional | The description of the level. |
experience_requirements | string | Optional | The experience requirements for the level. |
global_level | JSON | Optional | |
global_level (anyOf 1) | integer | Alternative | Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level). |
global_level (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the level. Must be unique within the company or organization. |
parent | Model | Optional | Expand Update a level — response body — parent The parent level. Expandable field |
parent_id | string | Optional | The parent level. |
rank | JSON | Optional | |
rank (anyOf 1) | integer | Alternative | The rank of the level within its track. |
rank (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
scope_of_responsibilities | string | Optional | The scope of responsibilities for the level. |
track | Model | Optional | Expand Update a level — response body — track |
track_id | string | Optional | The track associated with the level. Required during creation. Include global_level when changing it. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a level — response body — parent, Update a level — response body — track
Retrieve a specific headcount position — response body — location factor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Location factor assigned to this headcount Expandable field |
adjustment_factor | JSON | Optional | |
adjustment_factor (anyOf 1) | number | Alternative | Compensation adjustment percentage |
adjustment_factor (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
country | Model | Optional | Expand Retrieve a specific location factor — response body — country |
created_at | string | Required within parent | Record creation date |
display_name | string | Optional | Human-readable name for the location factor |
id | string | Required within parent | Identifier field |
labour_bucket | string | Optional | The labor market category (e.g., "Engineering", "Marketing", "Sales") |
updated_at | string | Required within parent | Record update date |
Referenced models: Retrieve a specific location factor — response body — country
Retrieve a specific headcount position — response body — recruiter
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Recruiter working on filling the position 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 — work location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Work location the headcount is assigned to Expandable field |
address | Model | Required within parent | Expand Update a work location — response body — address |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the work location. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a work location — response body — address
Retrieve a specific headcount position — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker hired into the headcount 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 job pay rate exception — response body — job code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job for which exception is configured. Expandable field |
created_at | string | Required within parent | Record creation date |
custom_location | Model | Optional | Expand Update a job code — response body — custom location |
department | Model | Optional | Expand Update a job code — response body — department |
department_id | string | Optional | The department associated with the job code. |
external_id | string | Optional | The unique identifier of the job code in an outside system. |
group_id | string | Optional | The ID of the job roster group. |
id | string | Required within parent | Identifier field |
is_archived | boolean | Optional | Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API. |
job_dimension | Model | Optional | Expand Update a job code — response body — job dimension |
job_dimension_id | string | Required within parent | The ID of the job dimension this job code belongs to. |
name | string | Required within parent | The name of the job dimension. |
pay_rate | JSON | Optional | |
pay_rate (anyOf 1) | number | Alternative | The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute. |
pay_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pay_rate_exceptions | array | Optional | Pay rate overrides for the job based on exception dimension values. Expandable field |
pay_rate_exceptions[] | Model | Each item | Expand List job pay rate exceptions — response body — results item |
pay_rate_exceptions_id | array | Optional | Pay rate overrides id for the job based on exception dimension values. |
pay_rate_exceptions_id[] | string | Each item | |
updated_at | string | Required within parent | Record update date |
work_location | Model | Optional | Expand Update a job code — response body — work location |
work_location_id | string | Optional | The work location associated with the job code. |
Referenced models: List job pay rate exceptions — response body — results item, Update a job code — response body — custom location, Update a job code — response body — department, Update a job code — response body — job dimension, Update a job code — response body — work location
Retrieve a specific leave balance — response body — leave type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The leave type associated with the leave balance. Expandable field |
created_at | string | Required within parent | Record creation date |
description | string | Optional | The description of the leave type. |
id | string | Required within parent | Identifier field |
is_managed_by_external_system | boolean | Required within parent | Whether the leave is managed by an external system. |
is_paid | boolean | Required within parent | Whether the leave is paid. |
name | string | Required within parent | The name of the leave type. |
type | string | Required within parent | The type of leave. |
updated_at | string | Required within parent | Record update date |
Retrieve a specific leave balance — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker associated with the leave balance. 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 legal entity — response body — company
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The company or organization associated with the legal entity Expandable field |
created_at | string | Required within parent | Record creation date |
doing_business_as_name | string | Optional | The doing business as name for the company. |
id | string | Required within parent | Identifier field |
legal_entities | array | Required within parent | A list of the company's entities. Expandable field |
legal_entities[] | Model | Each item | Expand Retrieve a specific legal entity — response body — parent |
legal_entities_id | array | Required within parent | A list of the company's entities. |
legal_entities_id[] | string | Each item | |
legal_name | string | Optional | The legal name of the company. |
name | string | Required within parent | The name of the company. |
parent_legal_entity | Model | Optional | Expand Retrieve a specific legal entity — response body — parent The company's ultimate holding entity. Expandable field |
parent_legal_entity_id | string | Optional | The company's ultimate holding entity. |
phone | string | Optional | The phone number for the company. |
physical_address | Model | Optional | Expand Retrieve my SSO information — response body — company physical address |
primary_email | string | Optional | The email address used when registering this company. |
updated_at | string | Required within parent | Record update date |
Referenced models: Retrieve a specific legal entity — response body — parent, Retrieve my SSO information — response body — company physical address
Retrieve a specific legal entity — response body — country
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The country the legal entity is based in. |
code | string | Required within parent | The code of the country. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
Retrieve a specific legal entity — response body — mailing address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The mailing address of the legal 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 legal entity — response body — parent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
company | Model | Optional | Expand Retrieve a specific legal entity — response body — company |
company_id | string | Optional | The company or organization associated with the legal entity |
country | Model | Optional | Expand Retrieve a specific legal entity — response body — country |
created_at | string | Required within parent | Record creation date |
entity_level | string | Optional | The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity. Known values: PARENT, SUBSIDIARY, BRANCH |
id | string | Required within parent | Identifier field |
legal_name | string | Optional | The legal name of the legal entity. |
mailing_address | Model | Optional | Expand Retrieve a specific legal entity — response body — mailing address |
management_type | string | Optional | The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR). Known values: PEO, EOR, COR |
parent | Model | Optional | Expand Retrieve a specific legal entity — response body — parent The parent legal entity. Expandable field |
parent_id | string | Optional | The parent legal entity. |
physical_address | Model | Optional | Expand Retrieve a specific legal entity — response body — physical address |
registration_date | string | Optional | The registration date of the entity. |
tax_identifier | string | Optional | The tax identifier for the legal entity. |
updated_at | string | Required within parent | Record update date |
Referenced models: Retrieve a specific legal entity — response body — parent, Retrieve a specific legal entity — response body — company, Retrieve a specific legal entity — response body — country, Retrieve a specific legal entity — response body — mailing address, Retrieve a specific legal entity — response body — physical address
Retrieve a specific legal entity — response body — physical address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The physical address of the legal 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 location factor — response body — country
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Country information set to the country code |
code | string | Required within parent | The code of the country. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
Retrieve a specific reimbursement — response body — end location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | End of a mileage trip. Null except on mileage reimbursements. |
address | string | Optional | Address of this point. Null when the point has no address. |
coordinates | Model | Optional | Expand Retrieve a specific reimbursement — response body — end location coordinates |
Referenced models: Retrieve a specific reimbursement — response body — end location coordinates
Retrieve a specific reimbursement — response body — end location coordinates
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Latitude and longitude of this point, in decimal degrees. Null when the point has no coordinates. |
latitude | JSON | Optional | |
latitude (anyOf 1) | number | Alternative | Latitude of this point, in decimal degrees. |
latitude (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
longitude | JSON | Optional | |
longitude (anyOf 1) | number | Alternative | Longitude of this point, in decimal degrees. |
longitude (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a specific reimbursement — response body — mileage rate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Company mileage rate. Include with `expand=mileage_rate` using `reimbursements.read`. Expandable field |
country | string | Optional | ISO 3166-1 alpha-2 country code. |
created_at | string | Required within parent | When the mileage rate was created, as an ISO 8601 date-time in UTC. |
end_date | string | Optional | Effective end date of the rate, as an ISO 8601 date (YYYY-MM-DD). |
half_cent | boolean | Optional | Whether an additional half cent per distance unit applies. |
id | string | Required within parent | Company mileage rate ID. |
name | string | Optional | Company-defined label for this mileage rate, such as the rate used for a country or vehicle type. |
rate | object | Optional | Amount per distance unit. The `value` is a decimal string. |
rate.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
rate.value | JSON | Optional | |
rate.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
rate.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
start_date | string | Optional | Effective start date of the rate, as an ISO 8601 date (YYYY-MM-DD). |
units | string | Optional | Distance unit, mi or km. Known values: km, mi |
updated_at | string | Required within parent | When the mileage rate was last updated, as an ISO 8601 date-time in UTC. |
Retrieve a specific reimbursement — response body — per diem line items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | object | Optional | Sub-rate amount for one unit. 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]+)?$ |
calculated_amount | object | Optional | amount times count. The `value` is a decimal string. Negative when line_type is EXCLUDE. |
calculated_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
calculated_amount.value | JSON | Optional | |
calculated_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
calculated_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
count | JSON | Optional | |
count (anyOf 1) | integer | Alternative | How many units. |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
label | string | Optional | Sub-rate label. |
line_type | string | Optional | `INCLUDE`: this row is added to the reimbursement. `EXCLUDE`: this row is subtracted. `calculated_amount.value` is negative when excluded. Known values: INCLUDE, EXCLUDE |
sub_rate_id | string | Optional | Per diem sub-rate ID. |
sub_rate_type | string | Optional | `FULL_DAY`: the full daily allowance. `MEALS`: the meals portion of the daily allowance. `OTHERS`: an allowance that is not the full day or meals. Known values: FULL_DAY, MEALS, OTHERS |
Retrieve a specific reimbursement — response body — per diem rate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Per diem rate for the trip. Include with `expand=per_diem_rate` using `reimbursements.read`. Expandable field |
country | string | Optional | Country this per diem rate applies to, as an ISO 3166-1 alpha-2 code. Example: US. |
created_at | string | Required within parent | When the per diem rate was created, as an ISO 8601 date-time in UTC. |
currency | string | Optional | Currency of the per diem rate, as an ISO 4217 code. Example: USD. |
destination_name | string | Optional | Place this per diem rate applies to, such as a city. |
end_date | string | Optional | Effective end date of the rate, as an ISO 8601 date (YYYY-MM-DD). |
id | string | Required within parent | Per diem rate ID. |
is_archived | boolean | Optional | Whether the rate is archived. Archived rates remain readable for historical references. |
is_current | boolean | Optional | Whether this is the current version of the rate. |
start_date | string | Optional | Effective start date of the rate, as an ISO 8601 date (YYYY-MM-DD). |
updated_at | string | Required within parent | When the per diem rate was last updated, as an ISO 8601 date-time in UTC. |
Retrieve a specific reimbursement — response body — start location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Start of a mileage trip. Null except on mileage reimbursements. |
address | string | Optional | Address of this point. Null when the point has no address. |
coordinates | Model | Optional | Expand Retrieve a specific reimbursement — response body — end location coordinates |
Referenced models: Retrieve a specific reimbursement — response body — end location coordinates
Retrieve a specific reimbursement — response body — vendor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Vendor details. Expand with `reimbursements.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 reimbursement — response body — waypoints item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Start, end, or intermediate stop on a mileage trip. |
address | string | Optional | Address of this point. Null when the point has no address. |
coordinates | Model | Optional | Expand Retrieve a specific reimbursement — response body — end location coordinates |
Referenced models: Retrieve a specific reimbursement — response body — end location coordinates
Retrieve a specific reimbursement — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker details. Expand with `reimbursements.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 time card — response body — summary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The summary of the time card. |
approved_hours | JSON | Optional | |
approved_hours (anyOf 1) | number | Alternative | The approved hours for the pay period. |
approved_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
double_overtime_hours | JSON | Optional | |
double_overtime_hours (anyOf 1) | number | Alternative | The total number of doubletime hours worked during the pay period. |
double_overtime_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
earnings | JSON | Optional | |
earnings (anyOf 1) | number | Alternative | The earnings for the pay period. |
earnings (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hours_worked_by_job_code | array | Optional | The amount of hours worked for each job code for the pay period. |
hours_worked_by_job_code[] | Model | Each item | Expand Retrieve a specific time card — response body — summary hours worked by job code item |
overtime_hours | JSON | Optional | |
overtime_hours (anyOf 1) | number | Alternative | The total number of overtime hours worked during the pay period. |
overtime_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
paid_hours | JSON | Optional | |
paid_hours (anyOf 1) | number | Alternative | The paid hours for the pay period. |
paid_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
premiums | JSON | Optional | |
premiums (anyOf 1) | number | Alternative | The premiums for the pay period. |
premiums (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
regular_hours | JSON | Optional | |
regular_hours (anyOf 1) | number | Alternative | The total number of regular hours worked during the pay period. |
regular_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_holiday_hours | JSON | Optional | |
total_holiday_hours (anyOf 1) | number | Alternative | The total holiday hours for the pay period. |
total_holiday_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_hours | JSON | Optional | |
total_hours (anyOf 1) | number | Alternative | The total hours for the pay period. |
total_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_paid_time_off_hours | JSON | Optional | |
total_paid_time_off_hours (anyOf 1) | number | Alternative | The total paid time off hours for the pay period. |
total_paid_time_off_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_unpaid_time_off_hours | JSON | Optional | |
total_unpaid_time_off_hours (anyOf 1) | number | Alternative | The total unpaid time off hours for the pay period. |
total_unpaid_time_off_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unpaid_break_hours_by_entry | JSON | Optional | |
unpaid_break_hours_by_entry (anyOf 1) | number | Alternative | The map of time entry to unpaidBreakHours in seconds |
unpaid_break_hours_by_entry (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve a specific time card — response body — summary hours worked by job code item
Retrieve a specific time card — response body — summary hours worked by job code item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hours_worked | JSON | Optional | |
hours_worked (anyOf 1) | number | Alternative | The total hours worked for the job codes. |
hours_worked (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
job_codes_id | array | Optional | List of job code ids that this summary is tracking hours for. |
job_codes_id[] | string | Each item |
Retrieve a specific time card — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker associated with the time card. 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 user — response body — addresses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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 user — response body — emails item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display | string | Optional | The display value of the email address. |
type | string | Optional | The classification of the email. Known values: HOME, WORK, OTHER |
value | string | Optional | A valid email address. |
Retrieve a specific user — response body — name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The user's name. |
family_name | string | Optional | The legal family name of the user, or last name in most Western languages. |
formatted | string | Optional | The user's full name. |
given_name | string | Optional | The given legal name of the user, or first name in most Western languages. |
middle_name | string | Optional | The middle name(s) of the user. |
preferred_family_name | string | Optional | The preferred family name, or last name in most Western languages, by the user. |
preferred_given_name | string | Optional | The preferred given name, or first name in most Western languages, by the user. |
Retrieve a specific user — response body — phone numbers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display | string | Optional | The display value of the phone number. |
type | string | Optional | The classification of the phone number, pursuant to SCIM RFC 7643 4.1.2. Known values: HOME, WORK, MOBILE, FAX, OTHER |
value | string | Optional | The canonical global phone number pursuant to RFC3966. |
Retrieve a specific user — response body — photos item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | The classification of the photo. Known values: PHOTO, THUMBNAIL |
value | string | Optional | The URL of the photo. |
Retrieve a specific worker change — response body — changed by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The actor as the current Worker DTO. Returned only when expand=changed_by is requested. 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 worker change — response body — changes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_type | string | Required within parent | VISIBLE or REDACTED. REDACTED means the caller's role lacks permission to read this field; from_value/to_value are null but the entry still appears so consumers know a change occurred. Known values: VISIBLE, REDACTED |
field_display_name | string | Required within parent | UI label for the field (English). |
field_key | string | Required within parent | Field key in snake_case. |
from_value | string | Optional | Value before the change, rendered as a display string (locale- and currency-formatted per the activity-log convention). Null when display_type is REDACTED. Typed JSON values are tracked as a future addition; consult value_type to interpret the rendering. |
to_value | string | Optional | Value after the change, rendered as a display string. Null when display_type is REDACTED. See from_value for notes on typed-value plans. |
value_type | string | Required within parent | The underlying value type of this field. Populated regardless of display_type so consumers can interpret from_value / to_value or anticipate a future typed representation. Known values: STRING, NUMBER, BOOLEAN, DATE, DATETIME, CURRENCY, ENUM, REFERENCE |
Retrieve a specific worker change — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The affected worker as the current Worker DTO. Returned only when expand=worker is requested. Includes terminated employees. 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 worker — response body — business partners item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_partner_group | object | Optional | Business partner group the business partner is a part of Expandable field |
business_partner_group.created_at | string | Required within parent | Record creation date |
business_partner_group.default_business_partner | Model | Optional | Expand Retrieve a specific worker — response body — manager Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group. Expandable field |
business_partner_group.default_business_partner_id | string | Optional | Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group. |
business_partner_group.domain | string | Optional | Type of business partner group Known values: HR, IT, FINANCE, RECRUITING, OTHER |
business_partner_group.id | string | Required within parent | Identifier field |
business_partner_group.name | string | Required within parent | Name used to identify business partner group |
business_partner_group.updated_at | string | Required within parent | Record update date |
business_partner_group_id | string | Required within parent | Identifier of business partner group the business parter is a part of |
client_group | Model | Optional | Expand Create a new business partner — response body — client group |
client_group_id | string | Optional | Identifier of group of workers associated with the business partner |
client_group_member_count | JSON | Optional | |
client_group_member_count (anyOf 1) | integer | Alternative | Number of workers associated with the business partner |
client_group_member_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific worker — response body — manager Worker who is the business partner Expandable field |
worker_id | string | Required within parent | Identifier of worker who is the business partner |
Referenced models: Retrieve a specific worker — response body — manager, Create a new business partner — response body — client group