Rippling: Rest API schemas (part 1)
68 Rippling schemas with complete fields and constraints.
← Rest API operations · All schemas
Apply file operations to a site bundle — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
base_bundle_id | string | Required within parent | Must match the site's current active bundle. Returns 409 when stale. |
entry_path | string | Optional | Optional bundle entry path. When omitted, the current entry path is kept. |
operations | array | Required within parent | Non-empty array of file or directory operations. |
operations[] | Model | Each item | Expand Apply file operations to a site bundle — request body — body operations item |
Referenced models: Apply file operations to a site bundle — request body — body operations item
Apply file operations to a site bundle — request body — body operations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_id | string | Optional | Staged upload id from POST /sites/upload-batches/presign/ after uploading bytes to S3. Required for put operations on files. The id can be reused for 1 hour from presign, each attach copies the bytes into that site's bundle, a repeat attach before expiry creates another bundle, and the staged object is removed after expiry. |
from_path | string | Optional | Source path for rename and move operations. |
kind | string | Required within parent | Target kind. Supported values are file and directory. |
op | string | Required within parent | Operation type. Supported values are put, rename, move, and delete. move is valid for files only; directories support put, rename, and delete. |
path | string | Optional | Target path for put and delete operations. |
recursive | boolean | Optional | When true, delete directory removes nested files. Used by delete directory operations. |
to_path | string | Optional | Destination path for rename and move operations. |
Check the authenticated caller's live assignment to an active permission profile, not its data-access grants — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The authenticated caller's membership in one active permission profile. |
is_member | boolean | Required within parent | Whether the authenticated caller belongs to this active permission profile in their company. False also covers nonexistent or unavailable profiles. |
Create a custom object list view — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A new saved grid definition that selects, filters, and orders a Custom Object's records. Additional keys: not allowed |
api_name | string | Optional | Case-sensitive API name, unique among active company views and immutable after creation. Use letters, digits, and underscores with a __c suffix. Generated when omitted. |
columns | array | Required within parent | Ordered, nonempty, unique field selection. |
columns[] | Model | Each item | Expand Create a custom object list view — request body — body columns item |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Creator-provided explanation of the records or purpose of this saved view. Defaults to null when omitted. |
description (anyOf 2) | null | Alternative | |
name | string | Required within parent | Nonblank display name. |
order_by | JSON | Optional | |
order_by (anyOf 1) | string | Alternative | One sortable field API name, a space, and lowercase asc or desc, for example name asc. Null clears saved ordering. |
order_by (anyOf 2) | null | Alternative | |
query | JSON | Optional | |
query (anyOf 1) | string | Alternative | Saved RQL predicate; null clears it. |
query (anyOf 2) | null | Alternative | |
record_scope | string | Optional | ALL includes all records the caller may read; MY_RECORDS restricts owners to the authenticated requester when the view is used. Defaults to ALL when omitted. One of: ALL, MY_RECORDS |
visibility | string | Optional | PRIVATE belongs to its creator; SHARED is visible within the company. Neither grants record access. Defaults to PRIVATE when omitted. One of: PRIVATE, SHARED |
Referenced models: Create a custom object list view — request body — body columns item
Create a custom object list view — request body — body columns item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A field selected for display at its position in a saved grid's ordered columns. Additional keys: not allowed |
field | string | Required within parent | Field API name. |
Create a custom object list view — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A saved grid definition, including its RQL predicate, for retrieval, editing, or duplication. |
api_name | string | Required within parent | Stable API name used to address this view. |
capabilities | Model | Required within parent | Expand Create a custom object list view — response body — capabilities |
columns | array | Required within parent | Visible columns, in saved display order. |
columns[] | Model | Each item | Expand Create a custom object list view — response body — columns item |
created_at | string | Required within parent | Time the view was created, as an ISO 8601 timestamp in UTC. Format: date-time |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Creator-provided explanation of the records or purpose of this saved view. Null when no explanation was saved. |
description (anyOf 2) | null | Alternative | |
has_filter | boolean | Required within parent | Whether this view applies a saved filter in addition to record_scope. The server resolves it when view_api_name is supplied to record queries. |
id | string | Required within parent | Read-only internal identifier; address operations using api_name. |
is_default | boolean | Required within parent | Whether this is the company's default view for this object. |
name | string | Required within parent | Display name of the saved view. |
order_by | JSON | Optional | |
order_by (anyOf 1) | string | Alternative | Saved ordering as one field API name, a space, and lowercase asc or desc, for example name asc. Null means no saved ordering. |
order_by (anyOf 2) | null | Alternative | |
query | JSON | Optional | |
query (anyOf 1) | string | Alternative | Saved RQL predicate, excluding record scope. Null when no predicate is saved. |
query (anyOf 2) | null | Alternative | |
record_scope | string | Required within parent | MY_RECORDS restricts owners to the authenticated requester when the view is used. Known values: ALL, MY_RECORDS |
updated_at | string | Required within parent | Time the view was last updated, as an ISO 8601 timestamp in UTC. Format: date-time |
visibility | string | Required within parent | PRIVATE belongs to its creator; SHARED is visible within the company. Neither grants record access. Known values: PRIVATE, SHARED |
Referenced models: Create a custom object list view — response body — columns item, Create a custom object list view — response body — capabilities
Create a custom object list view — response body — capabilities
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Actions available to this caller. |
can_delete | boolean | Required within parent | Whether the caller may delete this view. |
can_duplicate | boolean | Required within parent | Whether the caller may create a copy of this definition. |
can_set_default | boolean | Required within parent | Whether the caller may make this view the company default. |
can_share | boolean | Required within parent | Whether the caller may make this private view shared. |
can_update | boolean | Required within parent | Whether the caller may edit this view. |
Create a custom object list view — response body — columns item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A visible field within a Custom Object list view. |
field | string | Required within parent | Field API name. |
Create a new agent — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
api_name | string | Required within parent | The API name of the agent |
description | string | Optional | The description of the agent |
is_for_evals | boolean | Optional | Whether the agent is used for evaluations |
name | string | Required within parent | The display name of the agent |
Create a new business partner group — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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. |
domain | string | Optional | Type of business partner group One of: HR, IT, FINANCE, RECRUITING, OTHER |
name | string | Required within parent | Name used to identify business partner group |
Create a new business partner group — response body — default business partner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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_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 Create a new business partner group — response body — default business partner 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: Create a new business partner group — response body — default business partner 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
Create a new business partner group — response body — default business partner business partners item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_partner_group | Model | Optional | Expand List business partner groups — response body — results item Business partner group the business partner is a part of Expandable field |
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: List business partner groups — response body — results item, Retrieve a specific worker — response body — manager, Create a new business partner — response body — client group
Create a new business partner — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_partner_group_id | string | Required within parent | Identifier of business partner group the business parter is a part of |
worker_id | string | Required within parent | Identifier of worker who is the business partner |
Create a new business partner — response body — business partner group
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Business partner group the business partner is a part of Expandable field |
created_at | string | Required within parent | Record creation date |
default_business_partner | Model | Optional | Expand Create a new business partner — response body — business partner group default business partner |
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. |
domain | string | Optional | Type of business partner group Known values: HR, IT, FINANCE, RECRUITING, OTHER |
id | string | Required within parent | Identifier field |
name | string | Required within parent | Name used to identify business partner group |
updated_at | string | Required within parent | Record update date |
Referenced models: Create a new business partner — response body — business partner group default business partner
Create a new business partner — response body — business partner group default business partner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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_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 List business partners — response body — results 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: List business partners — response body — results item, Update a team — response body — parent, Retrieve a specific worker — response body — work schedule value, Retrieve a specific worker — response body — manager, Retrieve a specific worker — response body — 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
Create a new business partner — response body — client group
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Group of workers associated with the business partner Expandable field |
allow_non_employees | boolean | Optional | Whether the group allows non employees |
app_owner_id | string | Optional | The id of the group's app owner. |
can_override_role_states | boolean | Optional | Whether the group can override role states |
created_at | string | Required within parent | Record creation date |
cumulatively_exhaustive_default | boolean | Optional | Whether the group is the cumulatively exhaustive default |
description | string | Optional | The group's description. |
display_name | string | Optional | The group's display name. |
group_type | string | Optional | The group type |
id | string | Required within parent | Identifier field |
ignore_prov_group_matching | boolean | Optional | Whether to ignore provisioning group matching when determining group membership |
include_terminated | boolean | Optional | Whether the group include terminated roles |
is_invisible | boolean | Optional | Whether the group is invisible |
mutually_exclusive_key | string | Optional | The group's mutually exclusive key |
name | string | Optional | The group's name. |
parent | string | Optional | The group's parent. |
priority | JSON | Optional | |
priority (anyOf 1) | integer | Alternative | The group's priority when calculating mutual exclusivity |
priority (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
read_only | boolean | Optional | Whether the group is read only. |
sub_group_type | string | Optional | The sub group type |
updated_at | string | Required within parent | Record update date |
Create a new business partner — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker who is the business partner 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 List business partners — response body — results 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: List business partners — response body — results item, Update a team — response body — parent, Retrieve a specific worker — response body — work schedule value, Retrieve a specific worker — response body — manager, Retrieve a specific worker — response body — 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
Create a new business-structure-path — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
job_code_id | string | Required within parent | The Job Code to place at this Business Structure path. |
parent_id | string | Optional | Id of the parent BusinessStructurePath. None for root path. |
Create a new business-structure-path — response body — parent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
job_codes | array | Optional | Ordered list of full JobCode objects for each job in the path, top to bottom. Populate via ?expand=job_codes. Requires both business-structure-paths.read and job-codes.read scopes. Expandable field |
job_codes[] | Model | Each item | Expand List job codes — response body — results item |
job_codes_id | array | Optional | Ordered list of Job code IDs from top to bottom. |
job_codes_id[] | string | Each item | |
name | string | Optional | Name of the path (e.g. 'SF Office > Coffee > Barista'). |
parent | Model | Optional | Expand Create a new business-structure-path — response body — parent The parent path. Expandable field |
parent_id | string | Optional | Id of the parent BusinessStructurePath. None for root path. |
updated_at | string | Required within parent | Record update date |
Referenced models: Create a new business-structure-path — response body — parent, List job codes — response body — results item
Create a new department — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | The name of the department. |
parent_id | string | Optional | The parent department. |
reference_code | string | Optional | Reference code of the department. |
Create a new developer program application — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Developer Program application resource for Path B existing-company apply. |
build_description | string | Optional | What the company plans to build on Rippling |
entrypoint | string | Optional | Apply entrypoint: llm_cli_apply or web_apply One of: llm_cli_apply, web_apply |
Create a new developer program application — response body — stages
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Application checklist stages |
access_ready | boolean | Optional | Whether ops approved the application and provisioning is pending |
application_submitted | boolean | Optional | Whether the application has been submitted |
email_confirmed | boolean | Optional | Whether the applicant email is confirmed |
start_building | boolean | Optional | Whether Developer Program access has been provisioned |
Create a new draft transition — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
effective_at | string | Required within parent | Effective timestamp applied to the entire draft transition request. |
items | array | Required within parent | Draft transition items to accept for asynchronous processing. |
items[] | Model | Each item | Expand Create a new draft transition — request body — body items item |
timezone | string | Required within parent | IANA timezone used to interpret and display the request's effective timestamp. |
Referenced models: Create a new draft transition — request body — body items item
Create a new draft transition — request body — body items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
changes | object | Required within parent | Requested role/profile changes for this item. |
changes.country_specific_info | object | Optional | Country-specific field changes supported by current draft transition flows. |
changes.employment_info | object | Optional | Employment information changes for the target role. |
changes.employment_info.annual_salary_equivalent | object | Optional | New annual salary equivalent. |
changes.employment_info.annual_salary_equivalent.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
changes.employment_info.annual_salary_equivalent.value | number | Optional | The decimal amount for the currency. |
changes.employment_info.currency | string | Optional | New compensation currency for a currency-only change. When monetary amounts are also supplied, this must match their currency_type. All monetary fields in one item must use the same currency. |
changes.employment_info.department_id | string | Optional | New department identifier for the target role. |
changes.employment_info.employment_type_id | string | Optional | New company employment type identifier for the target role. |
changes.employment_info.equity_num_shares | integer | Optional | New offer letter equity share count. |
changes.employment_info.equity_value | object | Optional | New offer letter equity value. |
changes.employment_info.equity_value.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
changes.employment_info.equity_value.value | number | Optional | The decimal amount for the currency. |
changes.employment_info.equity_vesting_package_id | string | Optional | New equity vesting package identifier. |
changes.employment_info.job_family_id | string | Optional | New job family identifier for the target role. |
changes.employment_info.level_id | string | Optional | New level identifier for the target role. |
changes.employment_info.manager_id | string | Optional | New manager role identifier for the target role. |
changes.employment_info.on_target_commission | object | Optional | New annual on-target commission amount. |
changes.employment_info.on_target_commission.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
changes.employment_info.on_target_commission.value | number | Optional | The decimal amount for the currency. |
changes.employment_info.relocation_reimbursement | object | Optional | New relocation reimbursement amount. |
changes.employment_info.relocation_reimbursement.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
changes.employment_info.relocation_reimbursement.value | number | Optional | The decimal amount for the currency. |
changes.employment_info.salary_per_unit | object | Optional | New compensation amount per salary unit. |
changes.employment_info.salary_per_unit.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
changes.employment_info.salary_per_unit.value | number | Optional | The decimal amount for the currency. |
changes.employment_info.salary_unit | string | Optional | New salary unit. |
changes.employment_info.start_date | string | Optional | New start date for the target role. |
changes.employment_info.target_annual_bonus | object | Optional | New target annual bonus amount. |
changes.employment_info.target_annual_bonus.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
changes.employment_info.target_annual_bonus.value | number | Optional | The decimal amount for the currency. |
changes.employment_info.target_annual_bonus_payment_frequency_unit | string | Optional | New target annual bonus payment frequency. One of: MONTH, QUARTER, YEAR, SEMI_ANNUAL |
changes.employment_info.target_annual_bonus_percent | number | Optional | New target annual bonus percentage. |
changes.employment_info.teams_ids | array | Optional | New team identifiers for the target role. |
changes.employment_info.teams_ids[] | string | Each item | |
changes.employment_info.title | string | Optional | New job title for the target role. |
changes.work_location_info | object | Optional | Work location changes for the target role. |
changes.work_location_info.country_code | string | Optional | New work country code for the target role. |
changes.work_location_info.location_id | string | Optional | New work location identifier for the target role. |
draft_grouping_preference | string | Optional | Controls whether this item should append to a compatible existing draft or create a new draft. One of: APPEND_TO_MATCHING_DRAFT, CREATE_NEW_DRAFT |
role_id | string | Required within parent | Target role identifier for this draft transition item. |
Create a new draft transition — response body — items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
changes | object | Required within parent | Requested role/profile changes for this item. |
changes.country_specific_info | object | Optional | Country-specific field changes supported by current draft transition flows. |
changes.employment_info | object | Optional | Employment information changes for the target role. |
changes.employment_info.annual_salary_equivalent | object | Optional | New annual salary equivalent. |
changes.employment_info.annual_salary_equivalent.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
changes.employment_info.annual_salary_equivalent.value | JSON | Optional | |
changes.employment_info.annual_salary_equivalent.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
changes.employment_info.annual_salary_equivalent.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
changes.employment_info.currency | string | Optional | New compensation currency for a currency-only change. When monetary amounts are also supplied, this must match their currency_type. All monetary fields in one item must use the same currency. |
changes.employment_info.department_id | string | Optional | New department identifier for the target role. |
changes.employment_info.employment_type_id | string | Optional | New company employment type identifier for the target role. |
changes.employment_info.equity_num_shares | JSON | Optional | |
changes.employment_info.equity_num_shares (anyOf 1) | integer | Alternative | New offer letter equity share count. |
changes.employment_info.equity_num_shares (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
changes.employment_info.equity_value | object | Optional | New offer letter equity value. |
changes.employment_info.equity_value.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
changes.employment_info.equity_value.value | JSON | Optional | |
changes.employment_info.equity_value.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
changes.employment_info.equity_value.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
changes.employment_info.equity_vesting_package_id | string | Optional | New equity vesting package identifier. |
changes.employment_info.job_family_id | string | Optional | New job family identifier for the target role. |
changes.employment_info.level_id | string | Optional | New level identifier for the target role. |
changes.employment_info.manager_id | string | Optional | New manager role identifier for the target role. |
changes.employment_info.on_target_commission | object | Optional | New annual on-target commission amount. |
changes.employment_info.on_target_commission.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
changes.employment_info.on_target_commission.value | JSON | Optional | |
changes.employment_info.on_target_commission.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
changes.employment_info.on_target_commission.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
changes.employment_info.relocation_reimbursement | object | Optional | New relocation reimbursement amount. |
changes.employment_info.relocation_reimbursement.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
changes.employment_info.relocation_reimbursement.value | JSON | Optional | |
changes.employment_info.relocation_reimbursement.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
changes.employment_info.relocation_reimbursement.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
changes.employment_info.salary_per_unit | object | Optional | New compensation amount per salary unit. |
changes.employment_info.salary_per_unit.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
changes.employment_info.salary_per_unit.value | JSON | Optional | |
changes.employment_info.salary_per_unit.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
changes.employment_info.salary_per_unit.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
changes.employment_info.salary_unit | string | Optional | New salary unit. |
changes.employment_info.start_date | string | Optional | New start date for the target role. |
changes.employment_info.target_annual_bonus | object | Optional | New target annual bonus amount. |
changes.employment_info.target_annual_bonus.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
changes.employment_info.target_annual_bonus.value | JSON | Optional | |
changes.employment_info.target_annual_bonus.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
changes.employment_info.target_annual_bonus.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
changes.employment_info.target_annual_bonus_payment_frequency_unit | string | Optional | New target annual bonus payment frequency. Known values: MONTH, QUARTER, YEAR, SEMI_ANNUAL |
changes.employment_info.target_annual_bonus_percent | JSON | Optional | |
changes.employment_info.target_annual_bonus_percent (anyOf 1) | number | Alternative | New target annual bonus percentage. |
changes.employment_info.target_annual_bonus_percent (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
changes.employment_info.teams_ids | array | Optional | New team identifiers for the target role. |
changes.employment_info.teams_ids[] | string | Each item | |
changes.employment_info.title | string | Optional | New job title for the target role. |
changes.work_location_info | object | Optional | Work location changes for the target role. |
changes.work_location_info.country_code | string | Optional | New work country code for the target role. |
changes.work_location_info.location_id | string | Optional | New work location identifier for the target role. |
draft_grouping_preference | string | Optional | Controls whether this item should append to a compatible existing draft or create a new draft. Known values: APPEND_TO_MATCHING_DRAFT, CREATE_NEW_DRAFT |
role_id | string | Required within parent | Target role identifier for this draft transition item. |
Create a new earnings-input — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | V2 DTO representing an external earnings input record. Used by: - GET /earnings-inputs/ (list) |
amount | string | Optional | Earning amount as a string-encoded decimal. |
assignment_type | string | Optional | How the earning is assigned (e.g. BY_PAY_PERIOD). |
company_entity_id | string | Optional | Identifier for the legal entity (company entity relationship) this earning is associated with. Use this to correlate earnings with a specific legal entity in a multi-entity company. |
earning_code | string | Optional | Code identifying the earning type (e.g. regular_salary). |
earning_end_date | string | Optional | End of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run. |
earning_start_date | string | Optional | Start of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run. |
external_id | string | Optional | External reference identifier for this earning. |
hours | string | Optional | Hours associated with this earning as a string-encoded decimal. |
is_overridden | boolean | Optional | Whether this earning's amount was manually overridden instead of using the calculated value. Always false for newly created earnings. |
pay_period_basis_date | string | Optional | The pay period basis date for this earning. |
run_id | string | Optional | Identifier of the payroll run this earning is assigned to, if any. |
status | string | Optional | Current status of the earnings input (e.g. UNASSIGNED, ASSIGNED). |
time_labels | array | Optional | Time tracking labels associated with this earning. |
time_labels[] | string | Each item | |
worker_id | string | Optional | Identifier of the worker (role ID). |
Create a new employee document — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Top-level request body for `POST /employee-documents/`. |
items | array | Required within parent | List of role/document items to process. No limit on number of items; total documents across all items must not exceed 40. |
items[] | Model | Each item | Expand Create a new employee document — request body — body items item |
Referenced models: Create a new employee document — request body — body items item
Create a new employee document — request body — body items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single item: attach `documents` to the worker identified by `worker_id`. |
documents | array | Required within parent | Documents to attach to the role. At least one required. Each entry references a FileUploadTracker by file_id. |
documents[] | Model | Each item | Expand Create a new employee document — response body — items item documents item |
folder_id | string | Optional | Optional destination folder for documents. Accepts either: (1) an ObjectId string for custom folders, or (2) a default folder identifier ('root', 'confidential_documents', 'notices', 'work_authorization'). When omitted, documents land at the root of the worker's profile (current default behavior). When supplied, the folder must exist, be in an active state, be provisioned for the target worker, and the caller must have UPLOAD permission on it — otherwise behavior is governed by `on_invalid_folder`. |
on_invalid_folder | string | Optional | Fallback behavior when `folder_id` is supplied but inaccessible. 'fail' (default) rejects each affected document with FOLDER_ACCESS_ERROR. 'fallback_to_root' uploads to the worker's root profile instead and attaches a FOLDER_ACCESS_FALLBACK warning to each result. Ignored when `folder_id` is omitted. One of: fail, fallback_to_root |
worker_id | string | Required within parent | Id of the worker to attach documents to. |
Referenced models: Create a new employee document — response body — items item documents item
Create a new employee document — response body — items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single item: attach `documents` to the worker identified by `worker_id`. |
documents | array | Required within parent | Documents to attach to the role. At least one required. Each entry references a FileUploadTracker by file_id. |
documents[] | Model | Each item | Expand Create a new employee document — response body — items item documents item |
folder_id | string | Optional | Optional destination folder for documents. Accepts either: (1) an ObjectId string for custom folders, or (2) a default folder identifier ('root', 'confidential_documents', 'notices', 'work_authorization'). When omitted, documents land at the root of the worker's profile (current default behavior). When supplied, the folder must exist, be in an active state, be provisioned for the target worker, and the caller must have UPLOAD permission on it — otherwise behavior is governed by `on_invalid_folder`. |
on_invalid_folder | string | Optional | Fallback behavior when `folder_id` is supplied but inaccessible. 'fail' (default) rejects each affected document with FOLDER_ACCESS_ERROR. 'fallback_to_root' uploads to the worker's root profile instead and attaches a FOLDER_ACCESS_FALLBACK warning to each result. Ignored when `folder_id` is omitted. Known values: fail, fallback_to_root |
worker_id | string | Required within parent | Id of the worker to attach documents to. |
Referenced models: Create a new employee document — response body — items item documents item
Create a new employee document — response body — items item documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A document to attach to a draft hire, referencing a pre-uploaded file. |
file_id | string | Required within parent | Id of a FileUploadTracker in ACTIVE status whose file should become a document on the hire |
name | string | Optional | Document name. Defaults to the uploaded file name when omitted. |
signature_date | string | Optional | Signature date in YYYY-MM-DD format. |
Create a new file — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response DTO for ``POST /files/`` and ``GET /files/{id}``. |
content_type | string | Optional | MIME type supplied by the client at create time |
display_name | string | Optional | Human-readable label for the file |
status | string | Required within parent | Lifecycle status: awaiting_upload | uploaded | active | infected |
upload_fields | object | Optional | Required form fields to include in the multipart POST to S3 alongside the file binary |
upload_url | string | Optional | S3 endpoint URL — POST your multipart form here to upload the file. Present only in the create response. |
url_data | object | Optional | URLs for accessing the uploaded file after a successful upload |
url_data.preview_url | string | Optional | CDN URL for previewing the uploaded file after upload completes |
url_data.s3_url | string | Optional | S3 URL where the file is accessible after upload |
Create a new function deployment — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_domains | array | Optional | Domains that function runs from this deployment are allowed to access |
allowed_domains[] | string | Each item | |
code | string | Optional | The code for the deployment |
dependencies | object | Optional | The dependencies of the deployment |
io_contract | object | Optional | Input and output JSON Schema contracts for the deployment |
options | object | Optional | Additional, runtime-specific options for the deployment |
runtime | string | Optional | The runtime for the deployment |
Create a new function execution — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inputs | object | Required within parent | The inputs of the execution |
Create a new function — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
api_name | string | Optional | The API name of the function |
code_draft | string | Optional | The current draft of code for the function |
dependencies | object | Optional | The dependencies of the function |
description | string | Optional | The function description |
is_async | boolean | Optional | Whether this function runs asynchronously |
listed_in_custom_apps | boolean | Optional | Whether this request-function is listed in the Custom Apps grid and navigation. Defaults to false on creation; omitted updates preserve the current value. Listing does not grant access or change deployment behavior. Only supported for request functions. Setting this field on an event function returns a validation error. |
name | string | Optional | The function name |
source_upload | object | Optional | Optional source ZIP checksum and size for request functions only. Create or update returns ephemeral source_upload_instructions; this input is not returned. |
source_upload.sha256 | string | Required within parent | SHA-256 of the exact ZIP bytes, written as 64 lowercase hexadecimal characters. |
source_upload.size_bytes | integer | Required within parent | Exact ZIP size in bytes, from 1 through 67108864 (64 MiB). |
type | string | Optional | Function type at creation. Defaults to event and cannot be changed afterward. One of: event, request |
Create a new job assignment — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
change_reason | string | Optional | Reason recorded on the change (e.g., the reason for scheduling an unassignment). |
effective_from | string | Optional | Date and time the change becomes effective (ISO 8601 format, e.g., 2025-11-07T17:00:00.000+00:00); defaults to current time in UTC if not provided. job_pay_rate_effective_from is ignored if this field is provided. |
job_code_id | string | Required within parent | Identifier of job that is assigned to worker |
job_pay_rate | number | Optional | The pay rate for job assigned to worker. This can be different from the job's standard pay rate and can be overriden for a worker. |
job_pay_rate_change_reason | string | Optional | This field is deprecated and will be removed in a future version, use the new change_reason field instead. |
job_pay_rate_effective_from | string | Optional | This field is deprecated and will be removed in a future version, use the new effective_from field instead. |
worker_id | string | Required within parent | Identifier of worker to whom job is assigned. |
Create a new job code — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_location | Model | Optional | Expand Update a job code — request body — body custom location |
external_id | string | Optional | The unique identifier of the job code in an outside system. |
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_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 | number | Optional | The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute. |
pay_rate_change_reason | string | Optional | Reason for setting, updating, or resetting the pay rate on this job code. |
pay_rate_effective_from | string | Optional | Date and time the pay rate becomes effective (ISO 8601 format YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to current time in UTC if not provided. |
Referenced models: Update a job code — request body — body custom location
Create a new job dimension — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_id | string | Optional | The unique identifier of the job dimension in a third party system |
includes_custom_location | boolean | Optional | Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true. |
name | string | Required within parent | The name of the job dimension |
org_attribute_associations | array | Optional | Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests. |
org_attribute_associations[] | JSON | Each item | One of: DEPARTMENT, WORK_LOCATION, PAY_RATE, ENTITY |
roster_type | string | Optional | The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group. One of: PER_DIMENSION, PER_JOB_CODE |
Create a new job requisition — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | DTO for creating JobRequisitions via the Platform API. Maps to the existing ATS JobRequisitionDTO for use with create_from_DTO service. |
confidential | boolean | Optional | Whether this requisition is confidential |
confidential_whitelist | array | Optional | List of role IDs allowed to view confidential requisition |
confidential_whitelist[] | string | Each item | |
coordinator_id | string | Optional | Coordinator role ID |
default_private_invites | boolean | Optional | Whether to default to private invites |
departments | array | Optional | List of department IDs |
departments[] | string | Each item | |
description | string | Optional | Job description |
employment_type_id | string | Optional | Company employment type ID |
hiring_manager_id | string | Optional | Hiring manager role ID |
is_evergreen | boolean | Optional | Whether this is an evergreen requisition |
levels | array | Optional | List of level IDs |
levels[] | string | Each item | |
name | string | Required within parent | Title/name of the job requisition |
pipeline_plan_id | string | Optional | Pipeline plan ID to use for this requisition |
recruiter_id | string | Optional | Primary recruiter role ID |
requisition_id | string | Optional | Customer-defined requisition ID. Auto-generated if not provided. |
salary_currency | string | Optional | Salary currency code |
salary_per_unit | number | Optional | Salary amount per unit |
salary_per_unit_high | number | Optional | Salary range upper bound |
salary_per_unit_low | number | Optional | Salary range lower bound |
salary_type | string | Optional | Salary type |
salary_unit | string | Optional | Salary unit (HOUR, DAY, WEEK, MONTH, YEAR, PAY_PERIOD) |
secondary_recruiters | array | Optional | List of secondary recruiter role IDs |
secondary_recruiters[] | string | Each item | |
sourcer_id | string | Optional | Sourcer role ID |
status | string | Optional | Job requisition status (e.g., DRAFT, OPEN, CLOSED) |
target_close | string | Optional | Target close date |
target_employee_start_date | string | Optional | Target employee start date |
teams | array | Optional | List of team IDs |
teams[] | string | Each item | |
title | string | Optional | Internal employee title |
work_locations | array | Optional | List of work location IDs |
work_locations[] | string | Each item |
Create a new kiosk badge — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
badge_id | string | Required within parent | The ID associated with the badge. Not to be confused with the record's ID. |
is_enabled | boolean | Optional | Whether this badge can be used with the Kiosk app. |
worker_id | string | Optional | The ID of the worker associated with the badge. |
worker_number | integer | Optional | The employee number of the worker associated with the badge. |
Create a new leave accrual — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Leave accrual resource representing time off credits granted to employees. Leave accruals track the allocation of paid time off (vacation, sick days, etc.) to employees based on company policies, manual grants, or other accrual sources. |
accrual_date | string | Required within parent | The date when this accrual becomes effective |
accrual_type | string | Optional | The type of accrual One of: AUTO, CARRYOVER_PENALTY, RESET_PENALTY, RESET_NEGATIVE_PENALTY, BALANCE_PENALTY, LEAVE_GRANT, BALANCE_CORRECTION_ADJUSTMENT, PAID_OUT, SUB_BALANCE_EXPIRATION, TANDA_ACCRUAL_BONUS, TILT_ADJUSTMENT, WORKFLOW_ACTION, EXPIRATION_DEDUCTION, EXPIRATION_PAYOUT, MANUAL_BALANCE_PAYOUT, CARRYOVER_PENALTY_PAYOUT, RESET_PENALTY_PAYOUT, HOLIDAY_ADJUSTMENT, HOURS_WORKED_TANDA, TENURE_MILESTONE, FR_COP_FRACTIONNEMENT |
comment | string | Optional | The comment for this accrual. This is required if the leave policy requires a comment on accruals. |
expiration_date | string | Optional | The date when this accrual expires (if applicable) |
grantor_id | string | Required within parent | The ID of the worker who granted this accrual. This is typically the Time Off admin. |
leave_type_id | string | Required within parent | The company leave type ID associated with this accrual |
monetary_amount_accrued | number | Optional | The monetary value of this accrual (for policies with monetary tracking) |
num_days | number | Optional | The number of days accrued. It can be negative for deductions. This is applicable if the policy tracks in days. |
num_hours | number | Optional | The number of hours accrued. It can be negative for deductions. This is applicable if the policy tracks in hours. |
worker_id | string | Required within parent | The ID of the worker for whom the accrual is for |
Create a new leave accrual — response body — grantor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker who granted this accrual. This is typically the Time Off admin. 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
Create a new leave accrual — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker for whom the accrual is for Expandable field |
business_partners | array | Optional | Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners. Expandable field |
business_partners[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
business_partners_id[] | string | Each item | |
citizenship | string | Optional | The countries that the worker has citizenship in. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
compensation_grade.label | string | Optional | The compensation grade's label. |
compensation_id | string | Optional | The compensation package for the worker. |
country | string | Optional | The worker's country. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
country_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
date_of_birth | string | Optional | The worker's date of birth. |
department | Model | Optional | Expand Retrieve a specific worker — response body — department |
department_id | string | Optional | The worker's assigned department. |
employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
employment_type_id | string | Optional | The worker's employment type. |
end_date | string | Optional | The end date of the worker. |
ethnicity | string | Optional | The identified ethnicity of the worker, if specified. Known values: HISPANIC_OR_LATINO, WHITE, BLACK_OR_AFRICAN_AMERICAN, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, ASIAN, AMERICAN_INDIAN_OR_ALASKA_NATIVE, TWO_OR_MORE_RACES, MIDDLE_EASTERN_OR_NORTH_AFRICAN, DECLINE_TO_SELF_IDENTIFY, AFRICAN, COLOURED, INDIAN, OTHER, PREFER_NOT_TO_SAY |
gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
id | string | Required within parent | Identifier field |
is_manager | boolean | Optional | Whether the worker is a manager |
job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
job_function.created_at | string | Required within parent | Record creation date |
job_function.id | string | Required within parent | Identifier field |
job_function.name | string | Optional | Displayed name of the job function |
job_function.updated_at | string | Required within parent | Record update date |
job_function_id | string | Optional | ID of the worker's job function. |
legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
legal_entity_id | string | Optional | The worker's associated legal entity. |
level | Model | Optional | Expand Retrieve a specific worker — response body — level |
level_id | string | Optional | The level of the worker. |
location | object | Optional | The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote. |
location.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
manager_id | string | Optional | The worker's manager. |
number | JSON | Optional | |
number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
personal_email | string | Optional | The worker's associated personal email address. |
race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
start_date | string | Optional | The start date of the worker. |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
teams | array | Optional | The worker's assigned teams. Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | The worker's assigned teams. |
teams_id[] | string | Each item | |
termination_details | object | Optional | The details of the worker's termination, if applicable. |
termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
title | string | Optional | The worker's title. |
title_effective_date | string | Optional | Title effective date |
updated_at | string | Required within parent | Record update date |
user | Model | Optional | Expand Retrieve a specific worker — response body — user |
user_id | string | Optional | The worker's associated user. |
work_email | string | Optional | The worker's associated work email address. |
work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
work_schedule.* | Model | Additional keys | Expand Retrieve a specific worker — response body — work schedule value |
Referenced models: Retrieve a specific worker — response body — business partners item, Update a team — response body — parent, Retrieve a specific worker — response body — work schedule value, Retrieve a specific worker — response body — manager, Retrieve a specific worker — response body — compensation, Retrieve a specific worker — response body — country fields, Retrieve a specific worker — response body — department, Retrieve a specific worker — response body — employment type, Retrieve a specific worker — response body — legal entity, Retrieve a specific worker — response body — level, Retrieve a specific worker — response body — user
Create a new leave request — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comments | string | Optional | The comments associated with the leave request. |
end_date | string | Required within parent | The end date of the leave request. |
end_date_custom_hours | number | Optional | The number of hours to take off on the end date. |
end_time | string | Optional | The end time of the leave request. |
leave_event_id | string | Optional | The ID of the leave event associated with the leave request, if any. |
leave_policy_id | string | Optional | The ID of the leave policy associated with the leave request, either leave_policy_id or leave_type_id must be provided. |
leave_type_id | string | Optional | The ID of the leave type associated with the leave request, either leave_policy_id or leave_type_id must be provided. |
reason_for_leave | string | Optional | The reason for the leave request. |
requester_id | string | Optional | The ID of the worker who requested the leave request. |
reviewed_at | string | Optional | The timestamp of when the leave request was reviewed. |
reviewer_id | string | Optional | The ID of the worker who reviewed the leave request. |
start_date | string | Required within parent | The start date of the leave request. |
start_date_custom_hours | number | Optional | The number of hours to take off on the start date. |
start_time | string | Optional | The start time of the leave request. |
status | string | Required within parent | The status of the leave request. One of: PENDING, APPROVED, REJECTED, CANCELED |
worker_id | string | Required within parent | The ID of the worker associated with the leave request. |
Create a new level — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Optional | The description of the level. |
experience_requirements | string | Optional | The experience requirements for the level. |
global_level | integer | Optional | 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). |
name | string | Required within parent | The name of the level. Must be unique within the company or organization. |
scope_of_responsibilities | string | Optional | The scope of responsibilities for the level. |
track_id | string | Required within parent | The track associated with the level. Required during creation. Include global_level when changing it. |
Create a new off-cycle payroll run — response body — errors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | Stable error code; an exception does not prove that no run was created. Known values: RUN_CREATION_OUTCOME_UNKNOWN |
company_entity_id | JSON | Required within parent | |
company_entity_id (anyOf 1) | string | Alternative | HRIS company entity relationship ID for the attempted run. Null if the relationship cannot be resolved. |
company_entity_id (anyOf 2) | null | Alternative | |
employment_split | string | Required within parent | Employment category for the attempted run. |
message | string | Required within parent | Safe description of the unconfirmed creation outcome and retry guidance. |
worker_ids | array | Required within parent | Role IDs in the run whose creation could not be confirmed. |
worker_ids[] | string | Each item |
Create a new off-cycle payroll run — response body — runs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
check_date | string | Required within parent | Payment date selected for this run. |
company_entity_id | JSON | Required within parent | |
company_entity_id (anyOf 1) | string | Alternative | HRIS company entity relationship ID for this run, matching company_entity_id on payroll run retrieval. Null if the relationship cannot be resolved. |
company_entity_id (anyOf 2) | null | Alternative | |
country_code | string | Required within parent | Country code of the payroll entity. |
employment_split | string | Required within parent | Worker eligibility category used to split this run, such as employees or contractors. |
pay_period | object | Required within parent | Pay period for this run. |
pay_period.end_date | string | Required within parent | End date of this run's pay period. |
pay_period.start_date | string | Required within parent | Start date of this run's pay period. |
run_configuration | object | Required within parent | Calculation configuration used for this run. |
run_configuration.pay_basis | string | Required within parent | Amount basis used by the created run. This API currently creates gross-pay runs. |
run_id | string | Required within parent | Identifier of the created draft payroll run. |
run_status | string | Required within parent | Status of the created payroll run. |
run_type | string | Required within parent | Type of the created payroll run. |
worker_ids | array | Required within parent | Role IDs included in this run. |
worker_ids[] | string | Each item |
Create a new package version — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Optional | The description of the package version |
version_number | string | Required within parent | The semantic version number for this package version |
Create a new payroll payment mode change — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
changes | array | Required within parent | Payment mode changes to process. The maximum batch size is 100. |
changes[] | Model | Each item | Expand Create a new payroll payment mode change — request body — body changes item |
Referenced models: Create a new payroll payment mode change — request body — body changes item
Create a new payroll payment mode change — request body — body changes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payment_mode | string | Required within parent | Canonical Global Payroll payment mode code to apply to the worker in the run. Known labels are DEFAULT (Default), BANK_FILE (Bank file), MANUAL (Manual), SAME_DAY_ACH (Same-day ACH), CHECK_PRINTING (Check printing), and CHECK_MAILING (Check mailing). One of: DEFAULT, BANK_FILE, MANUAL, SAME_DAY_ACH, CHECK_PRINTING, CHECK_MAILING |
run_id | string | Required within parent | ID of the draft Global Payroll run to update. |
worker_id | string | Required within parent | ID of the worker whose payment mode will be updated. |
Create a new payroll payment mode change — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
results | array | Optional | Item-level results for the requested payment mode changes. Each item is either updated or rejected so callers can retry failed items independently. |
results[] | Model | Each item | Expand Create a new payroll payment mode change — response body — results item |
write_status | string | Optional | Completion status for this synchronous request. This is currently always COMPLETED; the field is reserved for future status values if processing becomes asynchronous. It describes the overall request, while each result status describes an individual item. Known values: COMPLETED |
Referenced models: Create a new payroll payment mode change — response body — results item
Create a new payroll payment mode change — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | object | Optional | Structured error when the item was rejected. This field is omitted for UPDATED items and is present for REJECTED items. |
error.code | string | Optional | Machine-readable error code for a rejected item. DUPLICATE_NO_OP means the requested change was already requested and no retry is needed; DUPLICATE_TARGET_CONFLICT, OUT_OF_SCOPE, RUN_NOT_FOUND, WORKER_NOT_IN_RUN, and PAYMENT_MODE_NOT_SUPPORTED are terminal request errors that require changing the request or authorization; RUN_NOT_WRITABLE may be retried when the run becomes writable; PAYMENT_MODE_UPDATE_FAILED is retryable after the underlying update failure is resolved. Known values: DUPLICATE_NO_OP, DUPLICATE_TARGET_CONFLICT, OUT_OF_SCOPE, RUN_NOT_FOUND, RUN_NOT_WRITABLE, WORKER_NOT_IN_RUN, PAYMENT_MODE_NOT_SUPPORTED, PAYMENT_MODE_UPDATE_FAILED |
error.message | string | Optional | Human-readable error message. |
payment_mode | string | Optional | Requested Global Payroll payment mode code. Known values: DEFAULT, BANK_FILE, MANUAL, SAME_DAY_ACH, CHECK_PRINTING, CHECK_MAILING |
run_id | string | Optional | ID of the requested payroll run. |
status | string | Optional | Item result: UPDATED or REJECTED. Known values: UPDATED, REJECTED |
worker_id | string | Optional | ID of the requested worker. |
Create a new sandbox — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
config_override | object | Optional | Optional create-only sandbox configuration. |
config_override.custom_objects | object | Optional | Custom objects copied into the sandbox. |
config_override.custom_objects.co_api_names | array | Optional | Custom object API names copied into the sandbox. |
config_override.custom_objects.co_api_names[] | string | Each item | |
config_override.developer | object | Optional | Required for developer sandboxes and omitted for full-data sandboxes. |
config_override.developer.company_size | string | Required within parent | Seed company size for the developer sandbox. MEDIUM is the supported value for new sandboxes. SMALL is retained for existing sandboxes only and is not supported on create. One of: SMALL, MEDIUM |
config_override.general_notifications | object | Optional | General outbound notification controls. |
config_override.general_notifications.email | object | Required within parent | Email notification configuration. |
config_override.general_notifications.email.allowed_users | array | Optional | Users allowed to receive outbound messages. |
config_override.general_notifications.email.allowed_users[] | string | Each item | |
config_override.general_notifications.email.outbound_behavior | string | Required within parent | Whether outbound messages are allowed or suppressed. One of: SUPPRESS, ALLOW |
config_override.general_notifications.push_notifications | object | Required within parent | Push notification configuration. |
config_override.general_notifications.push_notifications.allowed_users | array | Optional | Users allowed to receive outbound messages. |
config_override.general_notifications.push_notifications.allowed_users[] | string | Each item | |
config_override.general_notifications.push_notifications.outbound_behavior | string | Required within parent | Whether outbound messages are allowed or suppressed. One of: SUPPRESS, ALLOW |
config_override.general_notifications.slack | object | Optional | Slack notification configuration. |
config_override.general_notifications.slack.allowed_public_channels | array | Optional | Public channels allowed to receive outbound messages. |
config_override.general_notifications.slack.allowed_public_channels[] | string | Each item | |
config_override.general_notifications.slack.allowed_users | array | Optional | Users allowed to receive outbound messages. |
config_override.general_notifications.slack.allowed_users[] | string | Each item | |
config_override.general_notifications.slack.outbound_behavior | string | Required within parent | Whether outbound messages are allowed or suppressed. One of: SUPPRESS, ALLOW |
config_override.general_notifications.sms | object | Required within parent | SMS notification configuration. |
config_override.general_notifications.sms.allowed_users | array | Optional | Users allowed to receive outbound messages. |
config_override.general_notifications.sms.allowed_users[] | string | Each item | |
config_override.general_notifications.sms.outbound_behavior | string | Required within parent | Whether outbound messages are allowed or suppressed. One of: SUPPRESS, ALLOW |
config_override.general_notifications.teams | object | Optional | Microsoft Teams notification configuration. |
config_override.general_notifications.teams.allowed_public_channels | array | Optional | Public channels allowed to receive outbound messages. |
config_override.general_notifications.teams.allowed_public_channels[] | string | Each item | |
config_override.general_notifications.teams.allowed_users | array | Optional | Users allowed to receive outbound messages. |
config_override.general_notifications.teams.allowed_users[] | string | Each item | |
config_override.general_notifications.teams.outbound_behavior | string | Required within parent | Whether outbound messages are allowed or suppressed. One of: SUPPRESS, ALLOW |
config_override.integrations | object | Optional | Required for connected full-data sandboxes. |
config_override.integrations.is_risk_acknowledged | boolean | Required within parent | Confirms acceptance of the risks of connected third-party integrations. |
config_override.sandbox_mode | string | Optional | Required for full-data sandboxes. Developer sandboxes default to CONNECTED. One of: CONNECTED, ISOLATED |
config_override.workflow_webhooks | object | Optional | Workflow webhook controls. |
config_override.workflow_webhooks.allowed_ips | array | Optional | IP addresses allowed to receive workflow webhooks. |
config_override.workflow_webhooks.allowed_ips[] | string | Each item | |
config_override.workflow_webhooks.allowlisted_webhook_urls | array | Optional | Webhook URLs allowed in the sandbox. |
config_override.workflow_webhooks.allowlisted_webhook_urls[] | string | Each item | |
config_override.workflow_webhooks.outbound_behavior | string | Optional | Whether workflow webhook traffic is allowed or suppressed. One of: SUPPRESS, ALLOW |
description | string | Optional | Optional sandbox description. |
name | string | Required within parent | Display name of the sandbox. |
type | string | Required within parent | Sandbox type. Supported value: "developer". One of: developer |
Create a new shift assignment — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_published | boolean | Required within parent | Whether the shift assignment is published. If true, the published_version will be the same as the shift_data |
schedule_id | string | Required within parent | The ID of the schedule |
shift_data | Model | Required within parent | Expand Update a shift assignment — request body — body shift data |
worker_id | string | Required within parent | The ID of the worker. Empty string '' to unassign if shift is from an open/empty shift. |
Referenced models: Update a shift assignment — request body — body shift data
Create a new shift input — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country_code | string | Required within parent | Two letter string designating country code which the shift input is associated. |
creator_id | string | Optional | The creator id associated with the shift input. |
name | string | Required within parent | Name of the shift unit. |
prompt | string | Required within parent | Prompt for the shift unit. |
type | string | Required within parent | Type of shift unit. |
Create a new software deployment — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active_group_type | string | Optional | Type of group targeting: 'Role' or 'Device'. One of: Role, Device |
group_id | string | Optional | Group ID for role-based targeting. Required if active_group_type is 'Role'. Must be null if 'Device'. |
ma_device_group_id | string | Optional | Device group ID for device-based targeting. Required if active_group_type is 'Device'. Must be null if 'Role'. |
software_id | string | Required within parent | The ID of the software to deploy. |
Create a new team — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | The name of the team. |
parent_id | string | Optional | The parent team |
Create a new track — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | The name of the track. Must be unique within the company or organization. |
order | integer | Optional | The one-based horizontal display order of the track. |
Create a new unassigned shift — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_published | boolean | Required within parent | Whether the shift is published |
open_shift_config | object | Optional | Configuration for an open shift. If present, this is an open shift (workers can sign up). If absent/None, this is an empty shift (placeholder). |
schedule_id | string | Required within parent | The ID of the schedule |
shift_data | Model | Required within parent | Expand Update a shift assignment — request body — body shift data |
target_count | integer | Required within parent | The target count of the shift |
Referenced models: Update a shift assignment — request body — body shift data
Create a new variable compensation payout write — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ai_conditions_summary | string | Optional | Optional markdown summary of the eligibility conditions. |
amount_base | object | Required within parent | Payout amount. |
amount_base.currency_type | string | Required within parent | Three-letter currency code. |
amount_base.value | string | Required within parent | Decimal payout amount encoded as a string. |
eligibility_sql | string | Optional | SQL eligibility expression. Omit to use the active-role default. |
group_name | string | Optional | Optional payout group label. |
payee_id | string | Required within parent | ID of the worker who receives this payout. |
payment_type | string | Required within parent | Key of the company payment type used for this payout. |
scheduled_date | string | Required within parent | Date on which the payout is scheduled. |
Create a new variable compensation payout — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount_base | object | Required within parent | Payout amount in the worker's base currency. |
amount_base.currency_type | string | Required within parent | Three-letter currency code. |
amount_base.value | string | Required within parent | Decimal amount encoded as a string. |
amount_usd | object | Required within parent | Payout amount converted to USD. |
amount_usd.currency_type | string | Required within parent | Three-letter currency code. |
amount_usd.value | string | Required within parent | Decimal amount encoded as a string. |
client | string | Required within parent | Client system that created the payout. One of: VC_PLAN_CYCLE, VC_EVENT_DRIVEN_PLAN, CUSTOM, MANUAL_PAYOUT, HRIS_SIGN_ON, OFFLINE_RECOMMENDATION |
description | string | Optional | Optional payout description. |
effective_end_date | string | Required within parent | End date of the covered pay period. |
effective_start_date | string | Required within parent | Start date of the covered pay period. |
external_id | string | Required within parent | External identifier unique per company and client. |
group_label_id | string | Optional | Group label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed. |
name | string | Optional | Optional payout name. |
payee_id | string | Required within parent | ID of the worker who receives this payout. Expandable payee (Worker DTO + workers.read) is deferred from v1; use GET /workers/{id}/ when needed. |
payout_type | string | Required within parent | Key of the company payout type used for this payout. Expand is deferred from v1; enumerate valid keys via GET /variable-compensation-payout-types/. |
scheduled_date | string | Required within parent | Date on which the payout is scheduled. |
source_label_id | string | Optional | Source label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed. |
Create a new work location — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Required within parent | Expand Update a work location — request body — body address |
name | string | Required within parent | The name of the work location. |
Referenced models: Update a work location — request body — body address
Create a package sandbox link — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request to link a package to a sandbox, or poll an EDIT-mode installation tracker. |
mode | string | Required within parent | How the sandbox is linked to the package (INSTALL or EDIT) |
package_key | string | Required within parent | The package key to link into the sandbox |
sandbox_company_id | string | Required within parent | The company receiving the sandbox package installation |
Create a package version from a manifest — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Optional package version description, independent of manifest metadata. |
description (anyOf 2) | null | Alternative | |
manifest | Model | Required within parent | Expand Create a package version from a manifest — request body — body manifest |
version_number | string | Required within parent | The semantic version number for the new draft version, for example 1.0.0. Minimum length: 1 |
Referenced models: Create a package version from a manifest — request body — body manifest
Create a package version from a manifest — request body — body manifest
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Complete desired package component snapshot from the SDK manifest. Additional keys: not allowed |
components | array | Required within parent | Complete desired component snapshot compiled from the Metadata SDK's defineManifest. Each entry requires its component type and full configuration for that type. An empty array creates an empty draft version; it cannot be published until components are added. |
components[] | object | Each item | |
components_to_delete | array | Optional | Must be omitted or an empty array. Versions are complete snapshots, so deletion instructions are rejected. Default: [] Maximum items: 0 |
components_to_delete[] | object | Each item | |
metadata | Model | Required within parent | Expand Export a package version manifest — response body — metadata |
Referenced models: Export a package version manifest — response body — metadata
Create a presigned staged upload batch — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_intents | array | Required within parent | Non-empty array of file upload intents to stage with presigned S3 upload URLs. |
file_intents[] | Model | Each item | Expand Create a presigned staged upload batch — request body — body file intents item |
Referenced models: Create a presigned staged upload batch — request body — body file intents item
Create a presigned staged upload batch — request body — body file intents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client_ref | string | Required within parent | Any unique client-chosen id echoed with the staged file_id for correlation. Not used server-side beyond the response. |
file_name | string | Required within parent | File name with extension (e.g. site.zip). Used to derive Content-Type and create/PATCH asset type. |
Create a presigned staged upload batch — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
files | array | Optional | Staged files created by the upload batch. |
files[] | Model | Each item | Expand Create a presigned staged upload batch — response body — files item |
upload_batch_id | string | Optional | Identifier for the staged upload batch. |
Referenced models: Create a presigned staged upload batch — response body — files item
Create a presigned staged upload batch — response body — files item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client_ref | string | Optional | Any unique client-chosen id echoed with the staged file_id for correlation. Not used server-side beyond the response. |
file_id | string | Optional | Staged upload identifier for use in create, update, or file operations after uploading bytes to S3. The id can be reused for 1 hour from presign, each attach copies the bytes into that site's bundle, a repeat attach before expiry creates another bundle, and the staged object is removed after expiry. |
file_name | string | Optional | Staged file name from the presign file_name intent. |
status | string | Optional | Upload status. Returns awaiting_upload after presign until the file is uploaded to S3. After the object exists in S3, status becomes active on first use. Attach does not consume the staged upload; it is removed after expiry. |
upload_fields | object | Optional | Form fields required for the S3 POST (send these before the file part). |
upload_url | string | Optional | Presigned S3 POST URL for uploading the file bytes. |