Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
base_bundle_idstringRequired within parentMust match the site's current active bundle. Returns 409 when stale.
entry_pathstringOptionalOptional bundle entry path. When omitted, the current entry path is kept.
operationsarrayRequired within parentNon-empty array of file or directory operations.
operations[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
file_idstringOptionalStaged 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_pathstringOptionalSource path for rename and move operations.
kindstringRequired within parentTarget kind. Supported values are file and directory.
opstringRequired within parentOperation type. Supported values are put, rename, move, and delete. move is valid for files only; directories support put, rename, and delete.
pathstringOptionalTarget path for put and delete operations.
recursivebooleanOptionalWhen true, delete directory removes nested files. Used by delete directory operations.
to_pathstringOptionalDestination 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

FieldTypePresenceDescription and constraints
$objectRootThe authenticated caller's membership in one active permission profile.
is_memberbooleanRequired within parentWhether 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

FieldTypePresenceDescription and constraints
$objectRootA new saved grid definition that selects, filters, and orders a Custom Object's records.
Additional keys: not allowed
api_namestringOptionalCase-sensitive API name, unique among active company views and immutable after creation. Use letters, digits, and underscores with a __c suffix. Generated when omitted.
columnsarrayRequired within parentOrdered, nonempty, unique field selection.
columns[]ModelEach itemExpand Create a custom object list view — request body — body columns item
descriptionJSONOptional
description (anyOf 1)stringAlternativeCreator-provided explanation of the records or purpose of this saved view. Defaults to null when omitted.
description (anyOf 2)nullAlternative
namestringRequired within parentNonblank display name.
order_byJSONOptional
order_by (anyOf 1)stringAlternativeOne sortable field API name, a space, and lowercase asc or desc, for example name asc. Null clears saved ordering.
order_by (anyOf 2)nullAlternative
queryJSONOptional
query (anyOf 1)stringAlternativeSaved RQL predicate; null clears it.
query (anyOf 2)nullAlternative
record_scopestringOptionalALL 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
visibilitystringOptionalPRIVATE 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

FieldTypePresenceDescription and constraints
$objectRootA field selected for display at its position in a saved grid's ordered columns.
Additional keys: not allowed
fieldstringRequired within parentField API name.

Create a custom object list view — response body

FieldTypePresenceDescription and constraints
$objectRootA saved grid definition, including its RQL predicate, for retrieval, editing, or duplication.
api_namestringRequired within parentStable API name used to address this view.
capabilitiesModelRequired within parentExpand Create a custom object list view — response body — capabilities
columnsarrayRequired within parentVisible columns, in saved display order.
columns[]ModelEach itemExpand Create a custom object list view — response body — columns item
created_atstringRequired within parentTime the view was created, as an ISO 8601 timestamp in UTC.
Format: date-time
descriptionJSONOptional
description (anyOf 1)stringAlternativeCreator-provided explanation of the records or purpose of this saved view. Null when no explanation was saved.
description (anyOf 2)nullAlternative
has_filterbooleanRequired within parentWhether this view applies a saved filter in addition to record_scope. The server resolves it when view_api_name is supplied to record queries.
idstringRequired within parentRead-only internal identifier; address operations using api_name.
is_defaultbooleanRequired within parentWhether this is the company's default view for this object.
namestringRequired within parentDisplay name of the saved view.
order_byJSONOptional
order_by (anyOf 1)stringAlternativeSaved 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)nullAlternative
queryJSONOptional
query (anyOf 1)stringAlternativeSaved RQL predicate, excluding record scope. Null when no predicate is saved.
query (anyOf 2)nullAlternative
record_scopestringRequired within parentMY_RECORDS restricts owners to the authenticated requester when the view is used.
Known values: ALL, MY_RECORDS
updated_atstringRequired within parentTime the view was last updated, as an ISO 8601 timestamp in UTC.
Format: date-time
visibilitystringRequired within parentPRIVATE 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

FieldTypePresenceDescription and constraints
$objectRootActions available to this caller.
can_deletebooleanRequired within parentWhether the caller may delete this view.
can_duplicatebooleanRequired within parentWhether the caller may create a copy of this definition.
can_set_defaultbooleanRequired within parentWhether the caller may make this view the company default.
can_sharebooleanRequired within parentWhether the caller may make this private view shared.
can_updatebooleanRequired within parentWhether the caller may edit this view.

Create a custom object list view — response body — columns item

FieldTypePresenceDescription and constraints
$objectRootA visible field within a Custom Object list view.
fieldstringRequired within parentField API name.

Create a new agent — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
api_namestringRequired within parentThe API name of the agent
descriptionstringOptionalThe description of the agent
is_for_evalsbooleanOptionalWhether the agent is used for evaluations
namestringRequired within parentThe display name of the agent

Create a new business partner group — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
default_business_partner_idstringOptionalId of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.
domainstringOptionalType of business partner group
One of: HR, IT, FINANCE, RECRUITING, OTHER
namestringRequired within parentName used to identify business partner group

Create a new business partner group — response body — default business partner

FieldTypePresenceDescription and constraints
$objectRootOptional 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_partnersarrayOptionalWorker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.

Expandable field
business_partners[]ModelEach itemExpand Create a new business partner group — response body — default business partner business partners item
business_partners_idarrayOptionalWorker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.
business_partners_id[]stringEach item
citizenshipstringOptionalThe countries that the worker has citizenship in.
Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
compensationModelOptionalExpand Retrieve a specific worker — response body — compensation
compensation_gradeobjectOptionalThe compensation grade assigned to the worker, if any.
compensation_grade.idstringOptionalThe compensation grade's unique identifier.
compensation_grade.labelstringOptionalThe compensation grade's label.
compensation_idstringOptionalThe compensation package for the worker.
countrystringOptionalThe worker's country.
Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
country_fieldsModelOptionalExpand Retrieve a specific worker — response body — country fields
created_atstringRequired within parentRecord creation date
custom_fieldsarrayOptionalCustom field values defined on the Employee object for this worker

Expandable field
custom_fields[]JSONEach itemAdditional keys: see wildcard field
custom_fields[].*JSONAdditional keys
date_of_birthstringOptionalThe worker's date of birth.
departmentModelOptionalExpand Retrieve a specific worker — response body — department
department_idstringOptionalThe worker's assigned department.
employment_typeModelOptionalExpand Retrieve a specific worker — response body — employment type
employment_type_idstringOptionalThe worker's employment type.
end_datestringOptionalThe end date of the worker.
ethnicitystringOptionalThe identified ethnicity of the worker, if specified.
Known values: HISPANIC_OR_LATINO, WHITE, BLACK_OR_AFRICAN_AMERICAN, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, ASIAN, AMERICAN_INDIAN_OR_ALASKA_NATIVE, TWO_OR_MORE_RACES, MIDDLE_EASTERN_OR_NORTH_AFRICAN, DECLINE_TO_SELF_IDENTIFY, AFRICAN, COLOURED, INDIAN, OTHER, PREFER_NOT_TO_SAY
genderstringOptionalThe gender of the worker, if specified.
Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY
idstringRequired within parentIdentifier field
is_managerbooleanOptionalWhether the worker is a manager
job_functionobjectOptionalThe worker's job function. When expanded, this field requires `job-functions.read`.

Expandable field
job_function.created_atstringRequired within parentRecord creation date
job_function.idstringRequired within parentIdentifier field
job_function.namestringOptionalDisplayed name of the job function
job_function.updated_atstringRequired within parentRecord update date
job_function_idstringOptionalID of the worker's job function.
legal_entityModelOptionalExpand Retrieve a specific worker — response body — legal entity
legal_entity_idstringOptionalThe worker's associated legal entity.
levelModelOptionalExpand Retrieve a specific worker — response body — level
level_idstringOptionalThe level of the worker.
locationobjectOptionalThe location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.
location.typestringRequired within parentThe type of location.
Known values: REMOTE, WORK
location.work_location_idstringRequired within parentThe work location, if the worker isn't remote.
managerModelOptionalExpand Retrieve a specific worker — response body — manager
The worker's manager.

Expandable field
manager_idstringOptionalThe worker's manager.
numberJSONOptional
number (anyOf 1)integerAlternativeThe worker's number within the organization.
number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
original_start_datestringOptionalThe worker's earliest start date across their employment history, excluding INIT roles.
overtime_exemptionstringOptionalThe worker's overtime exemption status.
Known values: EXEMPT, NON_EXEMPT
pay_schedule_idstringOptionalThe ID of the pay schedule currently associated with the worker.
personal_emailstringOptionalThe worker's associated personal email address.
racestringOptionalThe identified race of the worker, if specified.
Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER
start_datestringOptionalThe start date of the worker.
statusstringOptionalThe worker's status within the organization.
Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED
teamsarrayOptionalThe worker's assigned teams.

Expandable field
teams[]ModelEach itemExpand Update a team — response body — parent
teams_idarrayOptionalThe worker's assigned teams.
teams_id[]stringEach item
termination_detailsobjectOptionalThe details of the worker's termination, if applicable.
termination_details.reasonstringOptionalThis is a description that will be custom to each Rippling company.
termination_details.typestringOptionalThe termination type indicates whether the termination was voluntary or involuntary.
Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE
titlestringOptionalThe worker's title.
title_effective_datestringOptionalTitle effective date
updated_atstringRequired within parentRecord update date
userModelOptionalExpand Retrieve a specific worker — response body — user
user_idstringOptionalThe worker's associated user.
work_emailstringOptionalThe worker's associated work email address.
work_scheduleobjectOptionalThe worker's scheduled working hours for each day of the week.
Additional keys: see wildcard field
work_schedule.*ModelAdditional keysExpand Retrieve a specific worker — response body — work schedule value

Referenced models: 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

FieldTypePresenceDescription and constraints
$objectRoot
business_partner_groupModelOptionalExpand List business partner groups — response body — results item
Business partner group the business partner is a part of

Expandable field
business_partner_group_idstringRequired within parentIdentifier of business partner group the business parter is a part of
client_groupModelOptionalExpand Create a new business partner — response body — client group
client_group_idstringOptionalIdentifier of group of workers associated with the business partner
client_group_member_countJSONOptional
client_group_member_count (anyOf 1)integerAlternativeNumber of workers associated with the business partner
client_group_member_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific worker — response body — manager
Worker who is the business partner

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

Referenced models: 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

FieldTypePresenceDescription and constraints
$objectRoot
business_partner_group_idstringRequired within parentIdentifier of business partner group the business parter is a part of
worker_idstringRequired within parentIdentifier of worker who is the business partner

Create a new business partner — response body — business partner group

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

Expandable field
created_atstringRequired within parentRecord creation date
default_business_partnerModelOptionalExpand Create a new business partner — response body — business partner group default business partner
default_business_partner_idstringOptionalId of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.
domainstringOptionalType of business partner group
Known values: HR, IT, FINANCE, RECRUITING, OTHER
idstringRequired within parentIdentifier field
namestringRequired within parentName used to identify business partner group
updated_atstringRequired within parentRecord 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

FieldTypePresenceDescription and constraints
$objectRootOptional 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_partnersarrayOptionalWorker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.

Expandable field
business_partners[]ModelEach itemExpand List business partners — response body — results item
business_partners_idarrayOptionalWorker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.
business_partners_id[]stringEach item
citizenshipstringOptionalThe countries that the worker has citizenship in.
Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
compensationModelOptionalExpand Retrieve a specific worker — response body — compensation
compensation_gradeobjectOptionalThe compensation grade assigned to the worker, if any.
compensation_grade.idstringOptionalThe compensation grade's unique identifier.
compensation_grade.labelstringOptionalThe compensation grade's label.
compensation_idstringOptionalThe compensation package for the worker.
countrystringOptionalThe worker's country.
Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
country_fieldsModelOptionalExpand Retrieve a specific worker — response body — country fields
created_atstringRequired within parentRecord creation date
custom_fieldsarrayOptionalCustom field values defined on the Employee object for this worker

Expandable field
custom_fields[]JSONEach itemAdditional keys: see wildcard field
custom_fields[].*JSONAdditional keys
date_of_birthstringOptionalThe worker's date of birth.
departmentModelOptionalExpand Retrieve a specific worker — response body — department
department_idstringOptionalThe worker's assigned department.
employment_typeModelOptionalExpand Retrieve a specific worker — response body — employment type
employment_type_idstringOptionalThe worker's employment type.
end_datestringOptionalThe end date of the worker.
ethnicitystringOptionalThe identified ethnicity of the worker, if specified.
Known values: HISPANIC_OR_LATINO, WHITE, BLACK_OR_AFRICAN_AMERICAN, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, ASIAN, AMERICAN_INDIAN_OR_ALASKA_NATIVE, TWO_OR_MORE_RACES, MIDDLE_EASTERN_OR_NORTH_AFRICAN, DECLINE_TO_SELF_IDENTIFY, AFRICAN, COLOURED, INDIAN, OTHER, PREFER_NOT_TO_SAY
genderstringOptionalThe gender of the worker, if specified.
Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY
idstringRequired within parentIdentifier field
is_managerbooleanOptionalWhether the worker is a manager
job_functionobjectOptionalThe worker's job function. When expanded, this field requires `job-functions.read`.

Expandable field
job_function.created_atstringRequired within parentRecord creation date
job_function.idstringRequired within parentIdentifier field
job_function.namestringOptionalDisplayed name of the job function
job_function.updated_atstringRequired within parentRecord update date
job_function_idstringOptionalID of the worker's job function.
legal_entityModelOptionalExpand Retrieve a specific worker — response body — legal entity
legal_entity_idstringOptionalThe worker's associated legal entity.
levelModelOptionalExpand Retrieve a specific worker — response body — level
level_idstringOptionalThe level of the worker.
locationobjectOptionalThe location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.
location.typestringRequired within parentThe type of location.
Known values: REMOTE, WORK
location.work_location_idstringRequired within parentThe work location, if the worker isn't remote.
managerModelOptionalExpand Retrieve a specific worker — response body — manager
The worker's manager.

Expandable field
manager_idstringOptionalThe worker's manager.
numberJSONOptional
number (anyOf 1)integerAlternativeThe worker's number within the organization.
number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
original_start_datestringOptionalThe worker's earliest start date across their employment history, excluding INIT roles.
overtime_exemptionstringOptionalThe worker's overtime exemption status.
Known values: EXEMPT, NON_EXEMPT
pay_schedule_idstringOptionalThe ID of the pay schedule currently associated with the worker.
personal_emailstringOptionalThe worker's associated personal email address.
racestringOptionalThe identified race of the worker, if specified.
Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER
start_datestringOptionalThe start date of the worker.
statusstringOptionalThe worker's status within the organization.
Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED
teamsarrayOptionalThe worker's assigned teams.

Expandable field
teams[]ModelEach itemExpand Update a team — response body — parent
teams_idarrayOptionalThe worker's assigned teams.
teams_id[]stringEach item
termination_detailsobjectOptionalThe details of the worker's termination, if applicable.
termination_details.reasonstringOptionalThis is a description that will be custom to each Rippling company.
termination_details.typestringOptionalThe termination type indicates whether the termination was voluntary or involuntary.
Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE
titlestringOptionalThe worker's title.
title_effective_datestringOptionalTitle effective date
updated_atstringRequired within parentRecord update date
userModelOptionalExpand Retrieve a specific worker — response body — user
user_idstringOptionalThe worker's associated user.
work_emailstringOptionalThe worker's associated work email address.
work_scheduleobjectOptionalThe worker's scheduled working hours for each day of the week.
Additional keys: see wildcard field
work_schedule.*ModelAdditional keysExpand Retrieve a specific worker — response body — work schedule value

Referenced models: 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

FieldTypePresenceDescription and constraints
$objectRootGroup of workers associated with the business partner

Expandable field
allow_non_employeesbooleanOptionalWhether the group allows non employees
app_owner_idstringOptionalThe id of the group's app owner.
can_override_role_statesbooleanOptionalWhether the group can override role states
created_atstringRequired within parentRecord creation date
cumulatively_exhaustive_defaultbooleanOptionalWhether the group is the cumulatively exhaustive default
descriptionstringOptionalThe group's description.
display_namestringOptionalThe group's display name.
group_typestringOptionalThe group type
idstringRequired within parentIdentifier field
ignore_prov_group_matchingbooleanOptionalWhether to ignore provisioning group matching when determining group membership
include_terminatedbooleanOptionalWhether the group include terminated roles
is_invisiblebooleanOptionalWhether the group is invisible
mutually_exclusive_keystringOptionalThe group's mutually exclusive key
namestringOptionalThe group's name.
parentstringOptionalThe group's parent.
priorityJSONOptional
priority (anyOf 1)integerAlternativeThe group's priority when calculating mutual exclusivity
priority (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
read_onlybooleanOptionalWhether the group is read only.
sub_group_typestringOptionalThe sub group type
updated_atstringRequired within parentRecord update date

Create a new business partner — response body — worker

FieldTypePresenceDescription and constraints
$objectRootWorker who is the business partner

Expandable field
business_partnersarrayOptionalWorker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.

Expandable field
business_partners[]ModelEach itemExpand List business partners — response body — results item
business_partners_idarrayOptionalWorker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.
business_partners_id[]stringEach item
citizenshipstringOptionalThe countries that the worker has citizenship in.
Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
compensationModelOptionalExpand Retrieve a specific worker — response body — compensation
compensation_gradeobjectOptionalThe compensation grade assigned to the worker, if any.
compensation_grade.idstringOptionalThe compensation grade's unique identifier.
compensation_grade.labelstringOptionalThe compensation grade's label.
compensation_idstringOptionalThe compensation package for the worker.
countrystringOptionalThe worker's country.
Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
country_fieldsModelOptionalExpand Retrieve a specific worker — response body — country fields
created_atstringRequired within parentRecord creation date
custom_fieldsarrayOptionalCustom field values defined on the Employee object for this worker

Expandable field
custom_fields[]JSONEach itemAdditional keys: see wildcard field
custom_fields[].*JSONAdditional keys
date_of_birthstringOptionalThe worker's date of birth.
departmentModelOptionalExpand Retrieve a specific worker — response body — department
department_idstringOptionalThe worker's assigned department.
employment_typeModelOptionalExpand Retrieve a specific worker — response body — employment type
employment_type_idstringOptionalThe worker's employment type.
end_datestringOptionalThe end date of the worker.
ethnicitystringOptionalThe identified ethnicity of the worker, if specified.
Known values: HISPANIC_OR_LATINO, WHITE, BLACK_OR_AFRICAN_AMERICAN, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, ASIAN, AMERICAN_INDIAN_OR_ALASKA_NATIVE, TWO_OR_MORE_RACES, MIDDLE_EASTERN_OR_NORTH_AFRICAN, DECLINE_TO_SELF_IDENTIFY, AFRICAN, COLOURED, INDIAN, OTHER, PREFER_NOT_TO_SAY
genderstringOptionalThe gender of the worker, if specified.
Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY
idstringRequired within parentIdentifier field
is_managerbooleanOptionalWhether the worker is a manager
job_functionobjectOptionalThe worker's job function. When expanded, this field requires `job-functions.read`.

Expandable field
job_function.created_atstringRequired within parentRecord creation date
job_function.idstringRequired within parentIdentifier field
job_function.namestringOptionalDisplayed name of the job function
job_function.updated_atstringRequired within parentRecord update date
job_function_idstringOptionalID of the worker's job function.
legal_entityModelOptionalExpand Retrieve a specific worker — response body — legal entity
legal_entity_idstringOptionalThe worker's associated legal entity.
levelModelOptionalExpand Retrieve a specific worker — response body — level
level_idstringOptionalThe level of the worker.
locationobjectOptionalThe location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.
location.typestringRequired within parentThe type of location.
Known values: REMOTE, WORK
location.work_location_idstringRequired within parentThe work location, if the worker isn't remote.
managerModelOptionalExpand Retrieve a specific worker — response body — manager
The worker's manager.

Expandable field
manager_idstringOptionalThe worker's manager.
numberJSONOptional
number (anyOf 1)integerAlternativeThe worker's number within the organization.
number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
original_start_datestringOptionalThe worker's earliest start date across their employment history, excluding INIT roles.
overtime_exemptionstringOptionalThe worker's overtime exemption status.
Known values: EXEMPT, NON_EXEMPT
pay_schedule_idstringOptionalThe ID of the pay schedule currently associated with the worker.
personal_emailstringOptionalThe worker's associated personal email address.
racestringOptionalThe identified race of the worker, if specified.
Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER
start_datestringOptionalThe start date of the worker.
statusstringOptionalThe worker's status within the organization.
Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED
teamsarrayOptionalThe worker's assigned teams.

Expandable field
teams[]ModelEach itemExpand Update a team — response body — parent
teams_idarrayOptionalThe worker's assigned teams.
teams_id[]stringEach item
termination_detailsobjectOptionalThe details of the worker's termination, if applicable.
termination_details.reasonstringOptionalThis is a description that will be custom to each Rippling company.
termination_details.typestringOptionalThe termination type indicates whether the termination was voluntary or involuntary.
Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE
titlestringOptionalThe worker's title.
title_effective_datestringOptionalTitle effective date
updated_atstringRequired within parentRecord update date
userModelOptionalExpand Retrieve a specific worker — response body — user
user_idstringOptionalThe worker's associated user.
work_emailstringOptionalThe worker's associated work email address.
work_scheduleobjectOptionalThe worker's scheduled working hours for each day of the week.
Additional keys: see wildcard field
work_schedule.*ModelAdditional keysExpand Retrieve a specific worker — response body — work schedule value

Referenced models: 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

FieldTypePresenceDescription and constraints
$objectRoot
job_code_idstringRequired within parentThe Job Code to place at this Business Structure path.
parent_idstringOptionalId of the parent BusinessStructurePath. None for root path.

Create a new business-structure-path — response body — parent

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
job_codesarrayOptionalOrdered 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[]ModelEach itemExpand List job codes — response body — results item
job_codes_idarrayOptionalOrdered list of Job code IDs from top to bottom.
job_codes_id[]stringEach item
namestringOptionalName of the path (e.g. 'SF Office > Coffee > Barista').
parentModelOptionalExpand Create a new business-structure-path — response body — parent
The parent path.

Expandable field
parent_idstringOptionalId of the parent BusinessStructurePath. None for root path.
updated_atstringRequired within parentRecord 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

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentThe name of the department.
parent_idstringOptionalThe parent department.
reference_codestringOptionalReference code of the department.

Create a new developer program application — request body — body

FieldTypePresenceDescription and constraints
$objectRootDeveloper Program application resource for Path B existing-company apply.
build_descriptionstringOptionalWhat the company plans to build on Rippling
entrypointstringOptionalApply entrypoint: llm_cli_apply or web_apply
One of: llm_cli_apply, web_apply

Create a new developer program application — response body — stages

FieldTypePresenceDescription and constraints
$objectRootApplication checklist stages
access_readybooleanOptionalWhether ops approved the application and provisioning is pending
application_submittedbooleanOptionalWhether the application has been submitted
email_confirmedbooleanOptionalWhether the applicant email is confirmed
start_buildingbooleanOptionalWhether Developer Program access has been provisioned

Create a new draft transition — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
effective_atstringRequired within parentEffective timestamp applied to the entire draft transition request.
itemsarrayRequired within parentDraft transition items to accept for asynchronous processing.
items[]ModelEach itemExpand Create a new draft transition — request body — body items item
timezonestringRequired within parentIANA 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

FieldTypePresenceDescription and constraints
$objectRoot
changesobjectRequired within parentRequested role/profile changes for this item.
changes.country_specific_infoobjectOptionalCountry-specific field changes supported by current draft transition flows.
changes.employment_infoobjectOptionalEmployment information changes for the target role.
changes.employment_info.annual_salary_equivalentobjectOptionalNew annual salary equivalent.
changes.employment_info.annual_salary_equivalent.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
changes.employment_info.annual_salary_equivalent.valuenumberOptionalThe decimal amount for the currency.
changes.employment_info.currencystringOptionalNew 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_idstringOptionalNew department identifier for the target role.
changes.employment_info.employment_type_idstringOptionalNew company employment type identifier for the target role.
changes.employment_info.equity_num_sharesintegerOptionalNew offer letter equity share count.
changes.employment_info.equity_valueobjectOptionalNew offer letter equity value.
changes.employment_info.equity_value.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
changes.employment_info.equity_value.valuenumberOptionalThe decimal amount for the currency.
changes.employment_info.equity_vesting_package_idstringOptionalNew equity vesting package identifier.
changes.employment_info.job_family_idstringOptionalNew job family identifier for the target role.
changes.employment_info.level_idstringOptionalNew level identifier for the target role.
changes.employment_info.manager_idstringOptionalNew manager role identifier for the target role.
changes.employment_info.on_target_commissionobjectOptionalNew annual on-target commission amount.
changes.employment_info.on_target_commission.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
changes.employment_info.on_target_commission.valuenumberOptionalThe decimal amount for the currency.
changes.employment_info.relocation_reimbursementobjectOptionalNew relocation reimbursement amount.
changes.employment_info.relocation_reimbursement.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
changes.employment_info.relocation_reimbursement.valuenumberOptionalThe decimal amount for the currency.
changes.employment_info.salary_per_unitobjectOptionalNew compensation amount per salary unit.
changes.employment_info.salary_per_unit.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
changes.employment_info.salary_per_unit.valuenumberOptionalThe decimal amount for the currency.
changes.employment_info.salary_unitstringOptionalNew salary unit.
changes.employment_info.start_datestringOptionalNew start date for the target role.
changes.employment_info.target_annual_bonusobjectOptionalNew target annual bonus amount.
changes.employment_info.target_annual_bonus.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
changes.employment_info.target_annual_bonus.valuenumberOptionalThe decimal amount for the currency.
changes.employment_info.target_annual_bonus_payment_frequency_unitstringOptionalNew target annual bonus payment frequency.
One of: MONTH, QUARTER, YEAR, SEMI_ANNUAL
changes.employment_info.target_annual_bonus_percentnumberOptionalNew target annual bonus percentage.
changes.employment_info.teams_idsarrayOptionalNew team identifiers for the target role.
changes.employment_info.teams_ids[]stringEach item
changes.employment_info.titlestringOptionalNew job title for the target role.
changes.work_location_infoobjectOptionalWork location changes for the target role.
changes.work_location_info.country_codestringOptionalNew work country code for the target role.
changes.work_location_info.location_idstringOptionalNew work location identifier for the target role.
draft_grouping_preferencestringOptionalControls 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_idstringRequired within parentTarget role identifier for this draft transition item.

Create a new draft transition — response body — items item

FieldTypePresenceDescription and constraints
$objectRoot
changesobjectRequired within parentRequested role/profile changes for this item.
changes.country_specific_infoobjectOptionalCountry-specific field changes supported by current draft transition flows.
changes.employment_infoobjectOptionalEmployment information changes for the target role.
changes.employment_info.annual_salary_equivalentobjectOptionalNew annual salary equivalent.
changes.employment_info.annual_salary_equivalent.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
changes.employment_info.annual_salary_equivalent.valueJSONOptional
changes.employment_info.annual_salary_equivalent.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
changes.employment_info.annual_salary_equivalent.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
changes.employment_info.currencystringOptionalNew 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_idstringOptionalNew department identifier for the target role.
changes.employment_info.employment_type_idstringOptionalNew company employment type identifier for the target role.
changes.employment_info.equity_num_sharesJSONOptional
changes.employment_info.equity_num_shares (anyOf 1)integerAlternativeNew offer letter equity share count.
changes.employment_info.equity_num_shares (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
changes.employment_info.equity_valueobjectOptionalNew offer letter equity value.
changes.employment_info.equity_value.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
changes.employment_info.equity_value.valueJSONOptional
changes.employment_info.equity_value.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
changes.employment_info.equity_value.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
changes.employment_info.equity_vesting_package_idstringOptionalNew equity vesting package identifier.
changes.employment_info.job_family_idstringOptionalNew job family identifier for the target role.
changes.employment_info.level_idstringOptionalNew level identifier for the target role.
changes.employment_info.manager_idstringOptionalNew manager role identifier for the target role.
changes.employment_info.on_target_commissionobjectOptionalNew annual on-target commission amount.
changes.employment_info.on_target_commission.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
changes.employment_info.on_target_commission.valueJSONOptional
changes.employment_info.on_target_commission.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
changes.employment_info.on_target_commission.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
changes.employment_info.relocation_reimbursementobjectOptionalNew relocation reimbursement amount.
changes.employment_info.relocation_reimbursement.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
changes.employment_info.relocation_reimbursement.valueJSONOptional
changes.employment_info.relocation_reimbursement.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
changes.employment_info.relocation_reimbursement.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
changes.employment_info.salary_per_unitobjectOptionalNew compensation amount per salary unit.
changes.employment_info.salary_per_unit.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
changes.employment_info.salary_per_unit.valueJSONOptional
changes.employment_info.salary_per_unit.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
changes.employment_info.salary_per_unit.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
changes.employment_info.salary_unitstringOptionalNew salary unit.
changes.employment_info.start_datestringOptionalNew start date for the target role.
changes.employment_info.target_annual_bonusobjectOptionalNew target annual bonus amount.
changes.employment_info.target_annual_bonus.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
changes.employment_info.target_annual_bonus.valueJSONOptional
changes.employment_info.target_annual_bonus.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
changes.employment_info.target_annual_bonus.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
changes.employment_info.target_annual_bonus_payment_frequency_unitstringOptionalNew target annual bonus payment frequency.
Known values: MONTH, QUARTER, YEAR, SEMI_ANNUAL
changes.employment_info.target_annual_bonus_percentJSONOptional
changes.employment_info.target_annual_bonus_percent (anyOf 1)numberAlternativeNew target annual bonus percentage.
changes.employment_info.target_annual_bonus_percent (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
changes.employment_info.teams_idsarrayOptionalNew team identifiers for the target role.
changes.employment_info.teams_ids[]stringEach item
changes.employment_info.titlestringOptionalNew job title for the target role.
changes.work_location_infoobjectOptionalWork location changes for the target role.
changes.work_location_info.country_codestringOptionalNew work country code for the target role.
changes.work_location_info.location_idstringOptionalNew work location identifier for the target role.
draft_grouping_preferencestringOptionalControls 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_idstringRequired within parentTarget role identifier for this draft transition item.

Create a new earnings-input — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
V2 DTO representing an external earnings input record.

Used by:
- GET /earnings-inputs/ (list)
amountstringOptionalEarning amount as a string-encoded decimal.
assignment_typestringOptionalHow the earning is assigned (e.g. BY_PAY_PERIOD).
company_entity_idstringOptionalIdentifier 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_codestringOptionalCode identifying the earning type (e.g. regular_salary).
earning_end_datestringOptionalEnd 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_datestringOptionalStart 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_idstringOptionalExternal reference identifier for this earning.
hoursstringOptionalHours associated with this earning as a string-encoded decimal.
is_overriddenbooleanOptionalWhether this earning's amount was manually overridden instead of using the calculated value. Always false for newly created earnings.
pay_period_basis_datestringOptionalThe pay period basis date for this earning.
run_idstringOptionalIdentifier of the payroll run this earning is assigned to, if any.
statusstringOptionalCurrent status of the earnings input (e.g. UNASSIGNED, ASSIGNED).
time_labelsarrayOptionalTime tracking labels associated with this earning.
time_labels[]stringEach item
worker_idstringOptionalIdentifier of the worker (role ID).

Create a new employee document — request body — body

FieldTypePresenceDescription and constraints
$objectRootTop-level request body for `POST /employee-documents/`.
itemsarrayRequired within parentList of role/document items to process. No limit on number of items; total documents across all items must not exceed 40.
items[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootA single item: attach `documents` to the worker identified by `worker_id`.
documentsarrayRequired within parentDocuments to attach to the role. At least one required. Each entry references a FileUploadTracker by file_id.
documents[]ModelEach itemExpand Create a new employee document — response body — items item documents item
folder_idstringOptionalOptional 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_folderstringOptionalFallback 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_idstringRequired within parentId 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

FieldTypePresenceDescription and constraints
$objectRootA single item: attach `documents` to the worker identified by `worker_id`.
documentsarrayRequired within parentDocuments to attach to the role. At least one required. Each entry references a FileUploadTracker by file_id.
documents[]ModelEach itemExpand Create a new employee document — response body — items item documents item
folder_idstringOptionalOptional 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_folderstringOptionalFallback 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_idstringRequired within parentId 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

FieldTypePresenceDescription and constraints
$objectRootA document to attach to a draft hire, referencing a pre-uploaded file.
file_idstringRequired within parentId of a FileUploadTracker in ACTIVE status whose file should become a document on the hire
namestringOptionalDocument name. Defaults to the uploaded file name when omitted.
signature_datestringOptionalSignature date in YYYY-MM-DD format.

Create a new file — request body — body

FieldTypePresenceDescription and constraints
$objectRootResponse DTO for ``POST /files/`` and ``GET /files/{id}``.
content_typestringOptionalMIME type supplied by the client at create time
display_namestringOptionalHuman-readable label for the file
statusstringRequired within parentLifecycle status: awaiting_upload | uploaded | active | infected
upload_fieldsobjectOptionalRequired form fields to include in the multipart POST to S3 alongside the file binary
upload_urlstringOptionalS3 endpoint URL — POST your multipart form here to upload the file. Present only in the create response.
url_dataobjectOptionalURLs for accessing the uploaded file after a successful upload
url_data.preview_urlstringOptionalCDN URL for previewing the uploaded file after upload completes
url_data.s3_urlstringOptionalS3 URL where the file is accessible after upload

Create a new function deployment — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
allowed_domainsarrayOptionalDomains that function runs from this deployment are allowed to access
allowed_domains[]stringEach item
codestringOptionalThe code for the deployment
dependenciesobjectOptionalThe dependencies of the deployment
io_contractobjectOptionalInput and output JSON Schema contracts for the deployment
optionsobjectOptionalAdditional, runtime-specific options for the deployment
runtimestringOptionalThe runtime for the deployment

Create a new function execution — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
inputsobjectRequired within parentThe inputs of the execution

Create a new function — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
api_namestringOptionalThe API name of the function
code_draftstringOptionalThe current draft of code for the function
dependenciesobjectOptionalThe dependencies of the function
descriptionstringOptionalThe function description
is_asyncbooleanOptionalWhether this function runs asynchronously
listed_in_custom_appsbooleanOptionalWhether 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.
namestringOptionalThe function name
source_uploadobjectOptionalOptional source ZIP checksum and size for request functions only. Create or update returns ephemeral source_upload_instructions; this input is not returned.
source_upload.sha256stringRequired within parentSHA-256 of the exact ZIP bytes, written as 64 lowercase hexadecimal characters.
source_upload.size_bytesintegerRequired within parentExact ZIP size in bytes, from 1 through 67108864 (64 MiB).
typestringOptionalFunction type at creation. Defaults to event and cannot be changed afterward.
One of: event, request

Create a new job assignment — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
change_reasonstringOptionalReason recorded on the change (e.g., the reason for scheduling an unassignment).
effective_fromstringOptionalDate 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_idstringRequired within parentIdentifier of job that is assigned to worker
job_pay_ratenumberOptionalThe 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_reasonstringOptionalThis field is deprecated and will be removed in a future version, use the new change_reason field instead.
job_pay_rate_effective_fromstringOptionalThis field is deprecated and will be removed in a future version, use the new effective_from field instead.
worker_idstringRequired within parentIdentifier of worker to whom job is assigned.

Create a new job code — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
custom_locationModelOptionalExpand Update a job code — request body — body custom location
external_idstringOptionalThe unique identifier of the job code in an outside system.
is_archivedbooleanOptionalWhether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.
job_dimension_idstringRequired within parentThe ID of the job dimension this job code belongs to.
namestringRequired within parentThe name of the job dimension.
pay_ratenumberOptionalThe pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.
pay_rate_change_reasonstringOptionalReason for setting, updating, or resetting the pay rate on this job code.
pay_rate_effective_fromstringOptionalDate 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

FieldTypePresenceDescription and constraints
$objectRoot
external_idstringOptionalThe unique identifier of the job dimension in a third party system
includes_custom_locationbooleanOptionalWhether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.
namestringRequired within parentThe name of the job dimension
org_attribute_associationsarrayOptionalOrganizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.
org_attribute_associations[]JSONEach itemOne of: DEPARTMENT, WORK_LOCATION, PAY_RATE, ENTITY
roster_typestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
DTO for creating JobRequisitions via the Platform API.
Maps to the existing ATS JobRequisitionDTO for use with create_from_DTO service.
confidentialbooleanOptionalWhether this requisition is confidential
confidential_whitelistarrayOptionalList of role IDs allowed to view confidential requisition
confidential_whitelist[]stringEach item
coordinator_idstringOptionalCoordinator role ID
default_private_invitesbooleanOptionalWhether to default to private invites
departmentsarrayOptionalList of department IDs
departments[]stringEach item
descriptionstringOptionalJob description
employment_type_idstringOptionalCompany employment type ID
hiring_manager_idstringOptionalHiring manager role ID
is_evergreenbooleanOptionalWhether this is an evergreen requisition
levelsarrayOptionalList of level IDs
levels[]stringEach item
namestringRequired within parentTitle/name of the job requisition
pipeline_plan_idstringOptionalPipeline plan ID to use for this requisition
recruiter_idstringOptionalPrimary recruiter role ID
requisition_idstringOptionalCustomer-defined requisition ID. Auto-generated if not provided.
salary_currencystringOptionalSalary currency code
salary_per_unitnumberOptionalSalary amount per unit
salary_per_unit_highnumberOptionalSalary range upper bound
salary_per_unit_lownumberOptionalSalary range lower bound
salary_typestringOptionalSalary type
salary_unitstringOptionalSalary unit (HOUR, DAY, WEEK, MONTH, YEAR, PAY_PERIOD)
secondary_recruitersarrayOptionalList of secondary recruiter role IDs
secondary_recruiters[]stringEach item
sourcer_idstringOptionalSourcer role ID
statusstringOptionalJob requisition status (e.g., DRAFT, OPEN, CLOSED)
target_closestringOptionalTarget close date
target_employee_start_datestringOptionalTarget employee start date
teamsarrayOptionalList of team IDs
teams[]stringEach item
titlestringOptionalInternal employee title
work_locationsarrayOptionalList of work location IDs
work_locations[]stringEach item

Create a new kiosk badge — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
badge_idstringRequired within parentThe ID associated with the badge. Not to be confused with the record's ID.
is_enabledbooleanOptionalWhether this badge can be used with the Kiosk app.
worker_idstringOptionalThe ID of the worker associated with the badge.
worker_numberintegerOptionalThe employee number of the worker associated with the badge.

Create a new leave accrual — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
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_datestringRequired within parentThe date when this accrual becomes effective
accrual_typestringOptionalThe 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
commentstringOptionalThe comment for this accrual. This is required if the leave policy requires a comment on accruals.
expiration_datestringOptionalThe date when this accrual expires (if applicable)
grantor_idstringRequired within parentThe ID of the worker who granted this accrual. This is typically the Time Off admin.
leave_type_idstringRequired within parentThe company leave type ID associated with this accrual
monetary_amount_accruednumberOptionalThe monetary value of this accrual (for policies with monetary tracking)
num_daysnumberOptionalThe number of days accrued. It can be negative for deductions. This is applicable if the policy tracks in days.
num_hoursnumberOptionalThe number of hours accrued. It can be negative for deductions. This is applicable if the policy tracks in hours.
worker_idstringRequired within parentThe ID of the worker for whom the accrual is for

Create a new leave accrual — response body — grantor

FieldTypePresenceDescription and constraints
$objectRootThe worker who granted this accrual. This is typically the Time Off admin.

Expandable field
business_partnersarrayOptionalWorker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.

Expandable field
business_partners[]ModelEach itemExpand Retrieve a specific worker — response body — business partners item
business_partners_idarrayOptionalWorker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.
business_partners_id[]stringEach item
citizenshipstringOptionalThe countries that the worker has citizenship in.
Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
compensationModelOptionalExpand Retrieve a specific worker — response body — compensation
compensation_gradeobjectOptionalThe compensation grade assigned to the worker, if any.
compensation_grade.idstringOptionalThe compensation grade's unique identifier.
compensation_grade.labelstringOptionalThe compensation grade's label.
compensation_idstringOptionalThe compensation package for the worker.
countrystringOptionalThe worker's country.
Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
country_fieldsModelOptionalExpand Retrieve a specific worker — response body — country fields
created_atstringRequired within parentRecord creation date
custom_fieldsarrayOptionalCustom field values defined on the Employee object for this worker

Expandable field
custom_fields[]JSONEach itemAdditional keys: see wildcard field
custom_fields[].*JSONAdditional keys
date_of_birthstringOptionalThe worker's date of birth.
departmentModelOptionalExpand Retrieve a specific worker — response body — department
department_idstringOptionalThe worker's assigned department.
employment_typeModelOptionalExpand Retrieve a specific worker — response body — employment type
employment_type_idstringOptionalThe worker's employment type.
end_datestringOptionalThe end date of the worker.
ethnicitystringOptionalThe identified ethnicity of the worker, if specified.
Known values: HISPANIC_OR_LATINO, WHITE, BLACK_OR_AFRICAN_AMERICAN, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, ASIAN, AMERICAN_INDIAN_OR_ALASKA_NATIVE, TWO_OR_MORE_RACES, MIDDLE_EASTERN_OR_NORTH_AFRICAN, DECLINE_TO_SELF_IDENTIFY, AFRICAN, COLOURED, INDIAN, OTHER, PREFER_NOT_TO_SAY
genderstringOptionalThe gender of the worker, if specified.
Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY
idstringRequired within parentIdentifier field
is_managerbooleanOptionalWhether the worker is a manager
job_functionobjectOptionalThe worker's job function. When expanded, this field requires `job-functions.read`.

Expandable field
job_function.created_atstringRequired within parentRecord creation date
job_function.idstringRequired within parentIdentifier field
job_function.namestringOptionalDisplayed name of the job function
job_function.updated_atstringRequired within parentRecord update date
job_function_idstringOptionalID of the worker's job function.
legal_entityModelOptionalExpand Retrieve a specific worker — response body — legal entity
legal_entity_idstringOptionalThe worker's associated legal entity.
levelModelOptionalExpand Retrieve a specific worker — response body — level
level_idstringOptionalThe level of the worker.
locationobjectOptionalThe location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.
location.typestringRequired within parentThe type of location.
Known values: REMOTE, WORK
location.work_location_idstringRequired within parentThe work location, if the worker isn't remote.
managerModelOptionalExpand Retrieve a specific worker — response body — manager
The worker's manager.

Expandable field
manager_idstringOptionalThe worker's manager.
numberJSONOptional
number (anyOf 1)integerAlternativeThe worker's number within the organization.
number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
original_start_datestringOptionalThe worker's earliest start date across their employment history, excluding INIT roles.
overtime_exemptionstringOptionalThe worker's overtime exemption status.
Known values: EXEMPT, NON_EXEMPT
pay_schedule_idstringOptionalThe ID of the pay schedule currently associated with the worker.
personal_emailstringOptionalThe worker's associated personal email address.
racestringOptionalThe identified race of the worker, if specified.
Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER
start_datestringOptionalThe start date of the worker.
statusstringOptionalThe worker's status within the organization.
Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED
teamsarrayOptionalThe worker's assigned teams.

Expandable field
teams[]ModelEach itemExpand Update a team — response body — parent
teams_idarrayOptionalThe worker's assigned teams.
teams_id[]stringEach item
termination_detailsobjectOptionalThe details of the worker's termination, if applicable.
termination_details.reasonstringOptionalThis is a description that will be custom to each Rippling company.
termination_details.typestringOptionalThe termination type indicates whether the termination was voluntary or involuntary.
Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE
titlestringOptionalThe worker's title.
title_effective_datestringOptionalTitle effective date
updated_atstringRequired within parentRecord update date
userModelOptionalExpand Retrieve a specific worker — response body — user
user_idstringOptionalThe worker's associated user.
work_emailstringOptionalThe worker's associated work email address.
work_scheduleobjectOptionalThe worker's scheduled working hours for each day of the week.
Additional keys: see wildcard field
work_schedule.*ModelAdditional keysExpand Retrieve a specific worker — response body — work schedule value

Referenced models: Retrieve a specific worker — response body — business partners item, Update a team — response body — parent, Retrieve a specific worker — response body — work schedule value, Retrieve a specific worker — response body — manager, Retrieve a specific worker — response body — compensation, Retrieve a specific worker — response body — country fields, Retrieve a specific worker — response body — department, Retrieve a specific worker — response body — employment type, Retrieve a specific worker — response body — legal entity, Retrieve a specific worker — response body — level, Retrieve a specific worker — response body — user

Create a new leave accrual — response body — worker

FieldTypePresenceDescription and constraints
$objectRootThe worker for whom the accrual is for

Expandable field
business_partnersarrayOptionalWorker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.

Expandable field
business_partners[]ModelEach itemExpand Retrieve a specific worker — response body — business partners item
business_partners_idarrayOptionalWorker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.
business_partners_id[]stringEach item
citizenshipstringOptionalThe countries that the worker has citizenship in.
Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
compensationModelOptionalExpand Retrieve a specific worker — response body — compensation
compensation_gradeobjectOptionalThe compensation grade assigned to the worker, if any.
compensation_grade.idstringOptionalThe compensation grade's unique identifier.
compensation_grade.labelstringOptionalThe compensation grade's label.
compensation_idstringOptionalThe compensation package for the worker.
countrystringOptionalThe worker's country.
Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
country_fieldsModelOptionalExpand Retrieve a specific worker — response body — country fields
created_atstringRequired within parentRecord creation date
custom_fieldsarrayOptionalCustom field values defined on the Employee object for this worker

Expandable field
custom_fields[]JSONEach itemAdditional keys: see wildcard field
custom_fields[].*JSONAdditional keys
date_of_birthstringOptionalThe worker's date of birth.
departmentModelOptionalExpand Retrieve a specific worker — response body — department
department_idstringOptionalThe worker's assigned department.
employment_typeModelOptionalExpand Retrieve a specific worker — response body — employment type
employment_type_idstringOptionalThe worker's employment type.
end_datestringOptionalThe end date of the worker.
ethnicitystringOptionalThe identified ethnicity of the worker, if specified.
Known values: HISPANIC_OR_LATINO, WHITE, BLACK_OR_AFRICAN_AMERICAN, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, ASIAN, AMERICAN_INDIAN_OR_ALASKA_NATIVE, TWO_OR_MORE_RACES, MIDDLE_EASTERN_OR_NORTH_AFRICAN, DECLINE_TO_SELF_IDENTIFY, AFRICAN, COLOURED, INDIAN, OTHER, PREFER_NOT_TO_SAY
genderstringOptionalThe gender of the worker, if specified.
Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY
idstringRequired within parentIdentifier field
is_managerbooleanOptionalWhether the worker is a manager
job_functionobjectOptionalThe worker's job function. When expanded, this field requires `job-functions.read`.

Expandable field
job_function.created_atstringRequired within parentRecord creation date
job_function.idstringRequired within parentIdentifier field
job_function.namestringOptionalDisplayed name of the job function
job_function.updated_atstringRequired within parentRecord update date
job_function_idstringOptionalID of the worker's job function.
legal_entityModelOptionalExpand Retrieve a specific worker — response body — legal entity
legal_entity_idstringOptionalThe worker's associated legal entity.
levelModelOptionalExpand Retrieve a specific worker — response body — level
level_idstringOptionalThe level of the worker.
locationobjectOptionalThe location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.
location.typestringRequired within parentThe type of location.
Known values: REMOTE, WORK
location.work_location_idstringRequired within parentThe work location, if the worker isn't remote.
managerModelOptionalExpand Retrieve a specific worker — response body — manager
The worker's manager.

Expandable field
manager_idstringOptionalThe worker's manager.
numberJSONOptional
number (anyOf 1)integerAlternativeThe worker's number within the organization.
number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
original_start_datestringOptionalThe worker's earliest start date across their employment history, excluding INIT roles.
overtime_exemptionstringOptionalThe worker's overtime exemption status.
Known values: EXEMPT, NON_EXEMPT
pay_schedule_idstringOptionalThe ID of the pay schedule currently associated with the worker.
personal_emailstringOptionalThe worker's associated personal email address.
racestringOptionalThe identified race of the worker, if specified.
Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER
start_datestringOptionalThe start date of the worker.
statusstringOptionalThe worker's status within the organization.
Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED
teamsarrayOptionalThe worker's assigned teams.

Expandable field
teams[]ModelEach itemExpand Update a team — response body — parent
teams_idarrayOptionalThe worker's assigned teams.
teams_id[]stringEach item
termination_detailsobjectOptionalThe details of the worker's termination, if applicable.
termination_details.reasonstringOptionalThis is a description that will be custom to each Rippling company.
termination_details.typestringOptionalThe termination type indicates whether the termination was voluntary or involuntary.
Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE
titlestringOptionalThe worker's title.
title_effective_datestringOptionalTitle effective date
updated_atstringRequired within parentRecord update date
userModelOptionalExpand Retrieve a specific worker — response body — user
user_idstringOptionalThe worker's associated user.
work_emailstringOptionalThe worker's associated work email address.
work_scheduleobjectOptionalThe worker's scheduled working hours for each day of the week.
Additional keys: see wildcard field
work_schedule.*ModelAdditional keysExpand Retrieve a specific worker — response body — work schedule value

Referenced models: Retrieve a specific worker — response body — business partners item, Update a team — response body — parent, Retrieve a specific worker — response body — work schedule value, Retrieve a specific worker — response body — manager, Retrieve a specific worker — response body — compensation, Retrieve a specific worker — response body — country fields, Retrieve a specific worker — response body — department, Retrieve a specific worker — response body — employment type, Retrieve a specific worker — response body — legal entity, Retrieve a specific worker — response body — level, Retrieve a specific worker — response body — user

Create a new leave request — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
commentsstringOptionalThe comments associated with the leave request.
end_datestringRequired within parentThe end date of the leave request.
end_date_custom_hoursnumberOptionalThe number of hours to take off on the end date.
end_timestringOptionalThe end time of the leave request.
leave_event_idstringOptionalThe ID of the leave event associated with the leave request, if any.
leave_policy_idstringOptionalThe ID of the leave policy associated with the leave request, either leave_policy_id or leave_type_id must be provided.
leave_type_idstringOptionalThe ID of the leave type associated with the leave request, either leave_policy_id or leave_type_id must be provided.
reason_for_leavestringOptionalThe reason for the leave request.
requester_idstringOptionalThe ID of the worker who requested the leave request.
reviewed_atstringOptionalThe timestamp of when the leave request was reviewed.
reviewer_idstringOptionalThe ID of the worker who reviewed the leave request.
start_datestringRequired within parentThe start date of the leave request.
start_date_custom_hoursnumberOptionalThe number of hours to take off on the start date.
start_timestringOptionalThe start time of the leave request.
statusstringRequired within parentThe status of the leave request.
One of: PENDING, APPROVED, REJECTED, CANCELED
worker_idstringRequired within parentThe ID of the worker associated with the leave request.

Create a new level — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringOptionalThe description of the level.
experience_requirementsstringOptionalThe experience requirements for the level.
global_levelintegerOptionalGlobal 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).
namestringRequired within parentThe name of the level. Must be unique within the company or organization.
scope_of_responsibilitiesstringOptionalThe scope of responsibilities for the level.
track_idstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
codestringRequired within parentStable error code; an exception does not prove that no run was created.
Known values: RUN_CREATION_OUTCOME_UNKNOWN
company_entity_idJSONRequired within parent
company_entity_id (anyOf 1)stringAlternativeHRIS company entity relationship ID for the attempted run. Null if the relationship cannot be resolved.
company_entity_id (anyOf 2)nullAlternative
employment_splitstringRequired within parentEmployment category for the attempted run.
messagestringRequired within parentSafe description of the unconfirmed creation outcome and retry guidance.
worker_idsarrayRequired within parentRole IDs in the run whose creation could not be confirmed.
worker_ids[]stringEach item

Create a new off-cycle payroll run — response body — runs item

FieldTypePresenceDescription and constraints
$objectRoot
check_datestringRequired within parentPayment date selected for this run.
company_entity_idJSONRequired within parent
company_entity_id (anyOf 1)stringAlternativeHRIS 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)nullAlternative
country_codestringRequired within parentCountry code of the payroll entity.
employment_splitstringRequired within parentWorker eligibility category used to split this run, such as employees or contractors.
pay_periodobjectRequired within parentPay period for this run.
pay_period.end_datestringRequired within parentEnd date of this run's pay period.
pay_period.start_datestringRequired within parentStart date of this run's pay period.
run_configurationobjectRequired within parentCalculation configuration used for this run.
run_configuration.pay_basisstringRequired within parentAmount basis used by the created run. This API currently creates gross-pay runs.
run_idstringRequired within parentIdentifier of the created draft payroll run.
run_statusstringRequired within parentStatus of the created payroll run.
run_typestringRequired within parentType of the created payroll run.
worker_idsarrayRequired within parentRole IDs included in this run.
worker_ids[]stringEach item

Create a new package version — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringOptionalThe description of the package version
version_numberstringRequired within parentThe semantic version number for this package version

Create a new payroll payment mode change — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
changesarrayRequired within parentPayment mode changes to process. The maximum batch size is 100.
changes[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
payment_modestringRequired within parentCanonical 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_idstringRequired within parentID of the draft Global Payroll run to update.
worker_idstringRequired within parentID of the worker whose payment mode will be updated.

Create a new payroll payment mode change — response body

FieldTypePresenceDescription and constraints
$objectRoot
resultsarrayOptionalItem-level results for the requested payment mode changes. Each item is either updated or rejected so callers can retry failed items independently.
results[]ModelEach itemExpand Create a new payroll payment mode change — response body — results item
write_statusstringOptionalCompletion 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

FieldTypePresenceDescription and constraints
$objectRoot
errorobjectOptionalStructured error when the item was rejected. This field is omitted for UPDATED items and is present for REJECTED items.
error.codestringOptionalMachine-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.messagestringOptionalHuman-readable error message.
payment_modestringOptionalRequested Global Payroll payment mode code.
Known values: DEFAULT, BANK_FILE, MANUAL, SAME_DAY_ACH, CHECK_PRINTING, CHECK_MAILING
run_idstringOptionalID of the requested payroll run.
statusstringOptionalItem result: UPDATED or REJECTED.
Known values: UPDATED, REJECTED
worker_idstringOptionalID of the requested worker.

Create a new sandbox — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
config_overrideobjectOptionalOptional create-only sandbox configuration.
config_override.custom_objectsobjectOptionalCustom objects copied into the sandbox.
config_override.custom_objects.co_api_namesarrayOptionalCustom object API names copied into the sandbox.
config_override.custom_objects.co_api_names[]stringEach item
config_override.developerobjectOptionalRequired for developer sandboxes and omitted for full-data sandboxes.
config_override.developer.company_sizestringRequired within parentSeed 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_notificationsobjectOptionalGeneral outbound notification controls.
config_override.general_notifications.emailobjectRequired within parentEmail notification configuration.
config_override.general_notifications.email.allowed_usersarrayOptionalUsers allowed to receive outbound messages.
config_override.general_notifications.email.allowed_users[]stringEach item
config_override.general_notifications.email.outbound_behaviorstringRequired within parentWhether outbound messages are allowed or suppressed.
One of: SUPPRESS, ALLOW
config_override.general_notifications.push_notificationsobjectRequired within parentPush notification configuration.
config_override.general_notifications.push_notifications.allowed_usersarrayOptionalUsers allowed to receive outbound messages.
config_override.general_notifications.push_notifications.allowed_users[]stringEach item
config_override.general_notifications.push_notifications.outbound_behaviorstringRequired within parentWhether outbound messages are allowed or suppressed.
One of: SUPPRESS, ALLOW
config_override.general_notifications.slackobjectOptionalSlack notification configuration.
config_override.general_notifications.slack.allowed_public_channelsarrayOptionalPublic channels allowed to receive outbound messages.
config_override.general_notifications.slack.allowed_public_channels[]stringEach item
config_override.general_notifications.slack.allowed_usersarrayOptionalUsers allowed to receive outbound messages.
config_override.general_notifications.slack.allowed_users[]stringEach item
config_override.general_notifications.slack.outbound_behaviorstringRequired within parentWhether outbound messages are allowed or suppressed.
One of: SUPPRESS, ALLOW
config_override.general_notifications.smsobjectRequired within parentSMS notification configuration.
config_override.general_notifications.sms.allowed_usersarrayOptionalUsers allowed to receive outbound messages.
config_override.general_notifications.sms.allowed_users[]stringEach item
config_override.general_notifications.sms.outbound_behaviorstringRequired within parentWhether outbound messages are allowed or suppressed.
One of: SUPPRESS, ALLOW
config_override.general_notifications.teamsobjectOptionalMicrosoft Teams notification configuration.
config_override.general_notifications.teams.allowed_public_channelsarrayOptionalPublic channels allowed to receive outbound messages.
config_override.general_notifications.teams.allowed_public_channels[]stringEach item
config_override.general_notifications.teams.allowed_usersarrayOptionalUsers allowed to receive outbound messages.
config_override.general_notifications.teams.allowed_users[]stringEach item
config_override.general_notifications.teams.outbound_behaviorstringRequired within parentWhether outbound messages are allowed or suppressed.
One of: SUPPRESS, ALLOW
config_override.integrationsobjectOptionalRequired for connected full-data sandboxes.
config_override.integrations.is_risk_acknowledgedbooleanRequired within parentConfirms acceptance of the risks of connected third-party integrations.
config_override.sandbox_modestringOptionalRequired for full-data sandboxes. Developer sandboxes default to CONNECTED.
One of: CONNECTED, ISOLATED
config_override.workflow_webhooksobjectOptionalWorkflow webhook controls.
config_override.workflow_webhooks.allowed_ipsarrayOptionalIP addresses allowed to receive workflow webhooks.
config_override.workflow_webhooks.allowed_ips[]stringEach item
config_override.workflow_webhooks.allowlisted_webhook_urlsarrayOptionalWebhook URLs allowed in the sandbox.
config_override.workflow_webhooks.allowlisted_webhook_urls[]stringEach item
config_override.workflow_webhooks.outbound_behaviorstringOptionalWhether workflow webhook traffic is allowed or suppressed.
One of: SUPPRESS, ALLOW
descriptionstringOptionalOptional sandbox description.
namestringRequired within parentDisplay name of the sandbox.
typestringRequired within parentSandbox type. Supported value: "developer".
One of: developer

Create a new shift assignment — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
is_publishedbooleanRequired within parentWhether the shift assignment is published. If true, the published_version will be the same as the shift_data
schedule_idstringRequired within parentThe ID of the schedule
shift_dataModelRequired within parentExpand Update a shift assignment — request body — body shift data
worker_idstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
country_codestringRequired within parentTwo letter string designating country code which the shift input is associated.
creator_idstringOptionalThe creator id associated with the shift input.
namestringRequired within parentName of the shift unit.
promptstringRequired within parentPrompt for the shift unit.
typestringRequired within parentType of shift unit.

Create a new software deployment — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
active_group_typestringOptionalType of group targeting: 'Role' or 'Device'.
One of: Role, Device
group_idstringOptionalGroup ID for role-based targeting. Required if active_group_type is 'Role'. Must be null if 'Device'.
ma_device_group_idstringOptionalDevice group ID for device-based targeting. Required if active_group_type is 'Device'. Must be null if 'Role'.
software_idstringRequired within parentThe ID of the software to deploy.

Create a new team — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentThe name of the team.
parent_idstringOptionalThe parent team

Create a new track — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentThe name of the track. Must be unique within the company or organization.
orderintegerOptionalThe one-based horizontal display order of the track.

Create a new unassigned shift — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
is_publishedbooleanRequired within parentWhether the shift is published
open_shift_configobjectOptionalConfiguration 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_idstringRequired within parentThe ID of the schedule
shift_dataModelRequired within parentExpand Update a shift assignment — request body — body shift data
target_countintegerRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
ai_conditions_summarystringOptionalOptional markdown summary of the eligibility conditions.
amount_baseobjectRequired within parentPayout amount.
amount_base.currency_typestringRequired within parentThree-letter currency code.
amount_base.valuestringRequired within parentDecimal payout amount encoded as a string.
eligibility_sqlstringOptionalSQL eligibility expression. Omit to use the active-role default.
group_namestringOptionalOptional payout group label.
payee_idstringRequired within parentID of the worker who receives this payout.
payment_typestringRequired within parentKey of the company payment type used for this payout.
scheduled_datestringRequired within parentDate on which the payout is scheduled.

Create a new variable compensation payout — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
amount_baseobjectRequired within parentPayout amount in the worker's base currency.
amount_base.currency_typestringRequired within parentThree-letter currency code.
amount_base.valuestringRequired within parentDecimal amount encoded as a string.
amount_usdobjectRequired within parentPayout amount converted to USD.
amount_usd.currency_typestringRequired within parentThree-letter currency code.
amount_usd.valuestringRequired within parentDecimal amount encoded as a string.
clientstringRequired within parentClient system that created the payout.
One of: VC_PLAN_CYCLE, VC_EVENT_DRIVEN_PLAN, CUSTOM, MANUAL_PAYOUT, HRIS_SIGN_ON, OFFLINE_RECOMMENDATION
descriptionstringOptionalOptional payout description.
effective_end_datestringRequired within parentEnd date of the covered pay period.
effective_start_datestringRequired within parentStart date of the covered pay period.
external_idstringRequired within parentExternal identifier unique per company and client.
group_label_idstringOptionalGroup label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed.
namestringOptionalOptional payout name.
payee_idstringRequired within parentID of the worker who receives this payout. Expandable payee (Worker DTO + workers.read) is deferred from v1; use GET /workers/{id}/ when needed.
payout_typestringRequired within parentKey of the company payout type used for this payout. Expand is deferred from v1; enumerate valid keys via GET /variable-compensation-payout-types/.
scheduled_datestringRequired within parentDate on which the payout is scheduled.
source_label_idstringOptionalSource 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

FieldTypePresenceDescription and constraints
$objectRoot
addressModelRequired within parentExpand Update a work location — request body — body address
namestringRequired within parentThe name of the work location.

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

Create a package sandbox link — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest to link a package to a sandbox, or poll an EDIT-mode installation tracker.
modestringRequired within parentHow the sandbox is linked to the package (INSTALL or EDIT)
package_keystringRequired within parentThe package key to link into the sandbox
sandbox_company_idstringRequired within parentThe company receiving the sandbox package installation

Create a package version from a manifest — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
descriptionJSONOptional
description (anyOf 1)stringAlternativeOptional package version description, independent of manifest metadata.
description (anyOf 2)nullAlternative
manifestModelRequired within parentExpand Create a package version from a manifest — request body — body manifest
version_numberstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootComplete desired package component snapshot from the SDK manifest.
Additional keys: not allowed
componentsarrayRequired within parentComplete 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[]objectEach item
components_to_deletearrayOptionalMust be omitted or an empty array. Versions are complete snapshots, so deletion instructions are rejected.
Default: []
Maximum items: 0
components_to_delete[]objectEach item
metadataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
file_intentsarrayRequired within parentNon-empty array of file upload intents to stage with presigned S3 upload URLs.
file_intents[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
client_refstringRequired within parentAny unique client-chosen id echoed with the staged file_id for correlation. Not used server-side beyond the response.
file_namestringRequired within parentFile 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

FieldTypePresenceDescription and constraints
$objectRoot
filesarrayOptionalStaged files created by the upload batch.
files[]ModelEach itemExpand Create a presigned staged upload batch — response body — files item
upload_batch_idstringOptionalIdentifier 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

FieldTypePresenceDescription and constraints
$objectRoot
client_refstringOptionalAny unique client-chosen id echoed with the staged file_id for correlation. Not used server-side beyond the response.
file_idstringOptionalStaged 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_namestringOptionalStaged file name from the presign file_name intent.
statusstringOptionalUpload 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_fieldsobjectOptionalForm fields required for the S3 POST (send these before the file part).
upload_urlstringOptionalPresigned S3 POST URL for uploading the file bytes.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.