Rippling: Rest API schemas (part 7)
65 Rippling schemas with complete fields and constraints.
← Rest API operations · All schemas
Retrieve a specific worker — response body — compensation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The compensation package for the worker. Expandable field |
annual_compensation | object | Optional | The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage. |
annual_compensation.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
annual_compensation.value | JSON | Optional | |
annual_compensation.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
annual_compensation.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
annual_salary_equivalent | object | Optional | The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation. |
annual_salary_equivalent.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
annual_salary_equivalent.value | JSON | Optional | |
annual_salary_equivalent.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
annual_salary_equivalent.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
bonus_schedule | string | Optional | The worker's bonus schedule. |
created_at | string | Required within parent | Record creation date |
hourly_wage | object | Optional | The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation. |
hourly_wage.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
hourly_wage.value | JSON | Optional | |
hourly_wage.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
hourly_wage.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Identifier field |
monthly_compensation | object | Optional | The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage. |
monthly_compensation.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
monthly_compensation.value | JSON | Optional | |
monthly_compensation.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
monthly_compensation.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
on_target_commission | object | Optional | The worker's on-target commission. |
on_target_commission.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
on_target_commission.value | JSON | Optional | |
on_target_commission.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
on_target_commission.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payment_terms | string | Optional | The payment terms for an worker's compensation. |
payment_type | string | Optional | The payment type for an worker's compensation. |
relocation_reimbursement | object | Optional | The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation. |
relocation_reimbursement.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
relocation_reimbursement.value | JSON | Optional | |
relocation_reimbursement.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
relocation_reimbursement.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
salary_effective_date | string | Optional | Salary effective date |
signing_bonus | object | Optional | The worker's signing bonus. |
signing_bonus.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
signing_bonus.value | JSON | Optional | |
signing_bonus.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
signing_bonus.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
target_annual_bonus | object | Optional | The worker's target annual bonus amount. |
target_annual_bonus.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
target_annual_bonus.value | JSON | Optional | |
target_annual_bonus.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
target_annual_bonus.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
target_annual_bonus_percent | JSON | Optional | |
target_annual_bonus_percent (anyOf 1) | number | Alternative | The worker's target annual bonus as a percent of annual compensation. |
target_annual_bonus_percent (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Record update date |
weekly_compensation | object | Optional | The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage. |
weekly_compensation.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
weekly_compensation.value | JSON | Optional | |
weekly_compensation.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
weekly_compensation.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
worker | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's details. Expandable field |
worker_id | string | Optional | The worker's ID. |
Referenced models: Retrieve a specific worker — response body — manager
Retrieve a specific worker — response body — country fields
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Country level fields for the worker. |
ca | object | Optional | Country-wise regional fields for Canada |
ca.sin | string | Optional | Social Insurance Number (SIN) for Canada employees. |
nz | object | Optional | Country-wise regional fields for New Zealand |
nz.ird_number | string | Optional | Inland Revenue Department (IRD) number for New Zealand employees. |
us | object | Optional | Country-wise regional fields for USA |
us.ssn | string | Optional | Social Security Number (SSN) for US employees. |
Retrieve a specific worker — response body — department
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker's assigned department. Expandable field |
created_at | string | Required within parent | Record creation date |
department_hierarchy | array | Optional | List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order. Expandable field |
department_hierarchy[] | Model | Each item | Expand Update a department — response body — parent |
department_hierarchy_id | array | Optional | The identifier of departments in the department hierarchy ordered from parent department to child department. |
department_hierarchy_id[] | string | Each item | |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the department. |
parent | Model | Optional | Expand Update a department — response body — parent The parent department. Expandable field |
parent_id | string | Optional | The parent department. |
reference_code | string | Optional | Reference code of the department. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a department — response body — parent
Retrieve a specific worker — response body — employment type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker's employment type. Expandable field |
amount_worked | string | Optional | The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually. Known values: PART-TIME, FULL-TIME, TEMPORARY |
compensation_time_period | string | Optional | The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked. Known values: HOURLY, SALARIED |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
label | string | Required within parent | The display label of the employment type. |
name | string | Optional | The name of the employment type for non-custom employment types. |
type | string | Optional | The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights. Known values: CONTRACTOR, EMPLOYEE |
updated_at | string | Required within parent | Record update date |
Retrieve a specific worker — response body — legal entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker's associated legal entity. Expandable field |
company | Model | Optional | Expand Retrieve a specific legal entity — response body — company |
company_id | string | Optional | The company or organization associated with the legal entity |
country | Model | Optional | Expand Retrieve a specific legal entity — response body — country |
created_at | string | Required within parent | Record creation date |
entity_level | string | Optional | The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity. Known values: PARENT, SUBSIDIARY, BRANCH |
id | string | Required within parent | Identifier field |
legal_name | string | Optional | The legal name of the legal entity. |
mailing_address | Model | Optional | Expand Retrieve a specific legal entity — response body — mailing address |
management_type | string | Optional | The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR). Known values: PEO, EOR, COR |
parent | Model | Optional | Expand Retrieve a specific legal entity — response body — parent The parent legal entity. Expandable field |
parent_id | string | Optional | The parent legal entity. |
physical_address | Model | Optional | Expand Retrieve a specific legal entity — response body — physical address |
registration_date | string | Optional | The registration date of the entity. |
tax_identifier | string | Optional | The tax identifier for the legal entity. |
updated_at | string | Required within parent | Record update date |
Referenced models: Retrieve a specific legal entity — response body — parent, Retrieve a specific legal entity — response body — company, Retrieve a specific legal entity — response body — country, Retrieve a specific legal entity — response body — mailing address, Retrieve a specific legal entity — response body — physical address
Retrieve a specific worker — response body — level
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The level of the worker. Expandable field |
created_at | string | Required within parent | Record creation date |
description | string | Optional | The description of the level. |
experience_requirements | string | Optional | The experience requirements for the level. |
global_level | JSON | Optional | |
global_level (anyOf 1) | integer | Alternative | Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level). |
global_level (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the level. Must be unique within the company or organization. |
parent | Model | Optional | Expand Update a level — response body — parent The parent level. Expandable field |
parent_id | string | Optional | The parent level. |
rank | JSON | Optional | |
rank (anyOf 1) | integer | Alternative | The rank of the level within its track. |
rank (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
scope_of_responsibilities | string | Optional | The scope of responsibilities for the level. |
track | Model | Optional | Expand Update a level — response body — track |
track_id | string | Optional | The track associated with the level. Required during creation. Include global_level when changing it. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a level — response body — parent, Update a level — response body — track
Retrieve a specific worker — response body — manager
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_partners | array | Optional | Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners. Expandable field |
business_partners[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
business_partners_id[] | string | Each item | |
citizenship | string | Optional | The countries that the worker has citizenship in. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
compensation_grade.label | string | Optional | The compensation grade's label. |
compensation_id | string | Optional | The compensation package for the worker. |
country | string | Optional | The worker's country. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
country_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
date_of_birth | string | Optional | The worker's date of birth. |
department | Model | Optional | Expand Retrieve a specific worker — response body — department |
department_id | string | Optional | The worker's assigned department. |
employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
employment_type_id | string | Optional | The worker's employment type. |
end_date | string | Optional | The end date of the worker. |
ethnicity | string | Optional | The identified ethnicity of the worker, if specified. Known values: HISPANIC_OR_LATINO, WHITE, BLACK_OR_AFRICAN_AMERICAN, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, ASIAN, AMERICAN_INDIAN_OR_ALASKA_NATIVE, TWO_OR_MORE_RACES, MIDDLE_EASTERN_OR_NORTH_AFRICAN, DECLINE_TO_SELF_IDENTIFY, AFRICAN, COLOURED, INDIAN, OTHER, PREFER_NOT_TO_SAY |
gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
id | string | Required within parent | Identifier field |
is_manager | boolean | Optional | Whether the worker is a manager |
job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
job_function.created_at | string | Required within parent | Record creation date |
job_function.id | string | Required within parent | Identifier field |
job_function.name | string | Optional | Displayed name of the job function |
job_function.updated_at | string | Required within parent | Record update date |
job_function_id | string | Optional | ID of the worker's job function. |
legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
legal_entity_id | string | Optional | The worker's associated legal entity. |
level | Model | Optional | Expand Retrieve a specific worker — response body — level |
level_id | string | Optional | The level of the worker. |
location | object | Optional | The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote. |
location.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
manager_id | string | Optional | The worker's manager. |
number | JSON | Optional | |
number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
personal_email | string | Optional | The worker's associated personal email address. |
race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
start_date | string | Optional | The start date of the worker. |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
teams | array | Optional | The worker's assigned teams. Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | The worker's assigned teams. |
teams_id[] | string | Each item | |
termination_details | object | Optional | The details of the worker's termination, if applicable. |
termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
title | string | Optional | The worker's title. |
title_effective_date | string | Optional | Title effective date |
updated_at | string | Required within parent | Record update date |
user | Model | Optional | Expand Retrieve a specific worker — response body — user |
user_id | string | Optional | The worker's associated user. |
work_email | string | Optional | The worker's associated work email address. |
work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
work_schedule.* | Model | Additional keys | Expand Retrieve a specific worker — response body — work schedule value |
Referenced models: Retrieve a specific worker — response body — business partners item, Update a team — response body — parent, Retrieve a specific worker — response body — work schedule value, Retrieve a specific worker — response body — manager, Retrieve a specific worker — response body — compensation, Retrieve a specific worker — response body — country fields, Retrieve a specific worker — response body — department, Retrieve a specific worker — response body — employment type, Retrieve a specific worker — response body — legal entity, Retrieve a specific worker — response body — level, Retrieve a specific worker — response body — user
Retrieve a specific worker — response body — user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker's associated user. Expandable field |
active | boolean | Optional | Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding. |
addresses | array | Optional | The user's addresses. |
addresses[] | Model | Each item | Expand Retrieve a specific user — response body — addresses item |
created_at | string | Required within parent | Record creation date |
display_name | string | Optional | The display name of the user using either the concatenated preferred given and family name or username depending on availability. |
emails | array | Optional | The user's email addresses. |
emails[] | Model | Each item | Expand Retrieve a specific user — response body — emails item |
id | string | Required within parent | Identifier field |
locale | string | Optional | The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646. |
name | Model | Optional | Expand Retrieve a specific user — response body — name |
number | string | Optional | The permanent profile number of the user. |
phone_numbers | array | Optional | The user's phone numbers. |
phone_numbers[] | Model | Each item | Expand Retrieve a specific user — response body — phone numbers item |
photos | array | Optional | The user's photos. |
photos[] | Model | Each item | Expand Retrieve a specific user — response body — photos item |
preferred_language | string | Optional | The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231. |
timezone | string | Optional | The User's current time zone in IANA database Olson format |
updated_at | string | Required within parent | Record update date |
username | string | Optional | The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique. |
Referenced models: Retrieve a specific user — response body — emails item, Retrieve a specific user — response body — addresses item, Retrieve a specific user — response body — phone numbers item, Retrieve a specific user — response body — photos item, Retrieve a specific user — response body — name
Retrieve a specific worker — response body — work schedule value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The scheduled working hours for a day of the week. |
hours | JSON | Optional | |
hours (anyOf 1) | number | Alternative | The number of scheduled working hours for the day. |
hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve an agent deployment — response body — diagnostics item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Optional | The diagnostic message |
path | string | Optional | The source path for the diagnostic |
severity | string | Optional | The diagnostic severity |
Retrieve list view capabilities for a custom object — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Permissions to create saved views and choose a company default for a Custom Object. |
can_create_private | boolean | Required within parent | Whether the caller may create private views. |
can_create_shared | boolean | Required within parent | Whether the caller may create shared views. |
can_set_default | boolean | Required within parent | Whether the caller may change the company default. |
Retrieve my SSO information — response body — company legal entities item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
company | Model | Optional | Expand List companies — response body — results item The company or organization associated with the legal entity Expandable field |
company_id | string | Optional | The company or organization associated with the legal entity |
country | Model | Optional | Expand Retrieve a specific legal entity — response body — country |
created_at | string | Required within parent | Record creation date |
entity_level | string | Optional | The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity. Known values: PARENT, SUBSIDIARY, BRANCH |
id | string | Required within parent | Identifier field |
legal_name | string | Optional | The legal name of the legal entity. |
mailing_address | Model | Optional | Expand Retrieve a specific legal entity — response body — mailing address |
management_type | string | Optional | The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR). Known values: PEO, EOR, COR |
parent | Model | Optional | Expand Retrieve a specific legal entity — response body — parent The parent legal entity. Expandable field |
parent_id | string | Optional | The parent legal entity. |
physical_address | Model | Optional | Expand Retrieve a specific legal entity — response body — physical address |
registration_date | string | Optional | The registration date of the entity. |
tax_identifier | string | Optional | The tax identifier for the legal entity. |
updated_at | string | Required within parent | Record update date |
Referenced models: List companies — response body — results item, Retrieve a specific legal entity — response body — parent, Retrieve a specific legal entity — response body — country, Retrieve a specific legal entity — response body — mailing address, Retrieve a specific legal entity — response body — physical address
Retrieve my SSO information — response body — company parent legal entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The company's ultimate holding entity. Expandable field |
company | Model | Optional | Expand List companies — response body — results item The company or organization associated with the legal entity Expandable field |
company_id | string | Optional | The company or organization associated with the legal entity |
country | Model | Optional | Expand Retrieve a specific legal entity — response body — country |
created_at | string | Required within parent | Record creation date |
entity_level | string | Optional | The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity. Known values: PARENT, SUBSIDIARY, BRANCH |
id | string | Required within parent | Identifier field |
legal_name | string | Optional | The legal name of the legal entity. |
mailing_address | Model | Optional | Expand Retrieve a specific legal entity — response body — mailing address |
management_type | string | Optional | The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR). Known values: PEO, EOR, COR |
parent | Model | Optional | Expand Retrieve a specific legal entity — response body — parent The parent legal entity. Expandable field |
parent_id | string | Optional | The parent legal entity. |
physical_address | Model | Optional | Expand Retrieve a specific legal entity — response body — physical address |
registration_date | string | Optional | The registration date of the entity. |
tax_identifier | string | Optional | The tax identifier for the legal entity. |
updated_at | string | Required within parent | Record update date |
Referenced models: List companies — response body — results item, Retrieve a specific legal entity — response body — parent, Retrieve a specific legal entity — response body — country, Retrieve a specific legal entity — response body — mailing address, Retrieve a specific legal entity — response body — physical address
Retrieve my SSO information — response body — company physical address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The physical address of the holding entity. |
country | string | Optional | The country component, pursuant to SCIM RFC 7643 4.1.2. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
formatted | string | Optional | The formatted mailing address. |
locality | string | Optional | The city or locality component. |
postal_code | string | Optional | The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2. |
region | string | Optional | The state or region component, pursuant to SCIM RFC 7643 4.1.2. |
street_address | string | Optional | The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2.. |
type | string | Optional | The classification of the address. Known values: HOME, WORK, OTHER |
Retrieve record details — response body
Referenced models: Retrieve record details — response body — fields / value / data_type: BOOLEAN, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: RADIO, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: CURRENCY, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: DATE, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: DATETIME, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — layout, Retrieve record details — response body — fields / value / data_type: SELECT, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: NUMBER, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / data_type: TEXT, LONG TEXT, EMAIL, URL, PHONE NUMBER, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — fields / value / value_state: PRESENT, EMPTY, MASKED, UNSUPPORTED, Retrieve record details — response body — capabilities
Retrieve record details — response body — capabilities
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Permissions and lock state for this caller. |
editable | boolean | Required within parent | Whether at least one field can be edited by this caller. |
locked | boolean | Required within parent | Whether the record is locked against changes. |
Retrieve record details — response body — fields / value / data_type: BOOLEAN, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A readable record field and the caller's ability to edit it. |
api_name | string | Required within parent | Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only. |
data_type | string | Required within parent | BOOLEAN contains true or false. Known values: BOOLEAN |
editable | boolean | Required within parent | Whether this caller can edit this field on this record. |
label | string | Required within parent | Field display name. |
multiple | boolean | Required within parent | Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references. |
options | array | Required within parent | Configured choice values; empty for non-choice fields. |
options[] | string | Each item | |
read_only_reason | JSON | Optional | |
read_only_reason (anyOf 1) | string | Alternative | PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable. Known values: PERMISSION_DENIED, RECORD_LOCKED, IMMUTABLE, MANAGED_OR_DERIVED, UNSUPPORTED_EDITOR, MASKED, REFERENCE_UNAVAILABLE |
read_only_reason (anyOf 2) | null | Alternative | |
reference_object | JSON | Optional | |
reference_object (anyOf 1) | string | Alternative | Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets. |
reference_object (anyOf 2) | null | Alternative | |
required | boolean | Required within parent | Whether a nonempty value is required by the field schema. |
value | JSON | Required within parent | |
value (anyOf 1) | boolean | Alternative | Whether the configured condition is true; null unless value_state is PRESENT. |
value (anyOf 2) | null | Alternative | |
value_state | string | Required within parent | PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array. Known values: PRESENT, EMPTY, MASKED, UNSUPPORTED |
Retrieve record details — response body — fields / value / data_type: CURRENCY, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A readable record field and the caller's ability to edit it. |
api_name | string | Required within parent | Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only. |
data_type | string | Required within parent | CURRENCY contains a monetary amount and its currency. Known values: CURRENCY |
editable | boolean | Required within parent | Whether this caller can edit this field on this record. |
label | string | Required within parent | Field display name. |
multiple | boolean | Required within parent | Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references. |
options | array | Required within parent | Configured choice values; empty for non-choice fields. |
options[] | string | Each item | |
read_only_reason | JSON | Optional | |
read_only_reason (anyOf 1) | string | Alternative | PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable. Known values: PERMISSION_DENIED, RECORD_LOCKED, IMMUTABLE, MANAGED_OR_DERIVED, UNSUPPORTED_EDITOR, MASKED, REFERENCE_UNAVAILABLE |
read_only_reason (anyOf 2) | null | Alternative | |
reference_object | JSON | Optional | |
reference_object (anyOf 1) | string | Alternative | Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets. |
reference_object (anyOf 2) | null | Alternative | |
required | boolean | Required within parent | Whether a nonempty value is required by the field schema. |
value | JSON | Required within parent | Platform Currency with an ISO 4217 currency_type and decimal value, for example {currency_type: USD, value: 25.00}. The amount is in currency units, not cents. Null unless value_state is PRESENT. |
value (anyOf 1) | Model | Alternative | Expand Retrieve record details — response body — fields / value / data_type: CURRENCY, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value currency type, value |
value (anyOf 2) | JSON | Alternative | |
value (anyOf 2) (anyOf 1) | string | Alternative | |
value (anyOf 2) (anyOf 2) | null | Alternative | |
value_state | string | Required within parent | PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array. Known values: PRESENT, EMPTY, MASKED, UNSUPPORTED |
Referenced models: Retrieve record details — response body — fields / value / data_type: CURRENCY, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value currency type, value
Retrieve record details — response body — fields / value / data_type: CURRENCY, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value currency type, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Platform Currency serialized with a decimal string amount to preserve precision. |
currency_type | string | Required within parent | ISO 4217 currency code, for example USD or EUR. Pattern: ^[A-Z]{3}$ |
value | string | Required within parent | Decimal monetary amount in currency units, for example 25.00; not integer cents. Pattern: ^[+-]?(?:\d+(?:\.\d*)?|\.\d+)(?:[eE][+-]?\d+)?$ |
Retrieve record details — response body — fields / value / data_type: DATE, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A readable record field and the caller's ability to edit it. |
api_name | string | Required within parent | Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only. |
data_type | string | Required within parent | DATE contains a calendar date without a time or timezone. Known values: DATE |
editable | boolean | Required within parent | Whether this caller can edit this field on this record. |
label | string | Required within parent | Field display name. |
multiple | boolean | Required within parent | Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references. |
options | array | Required within parent | Configured choice values; empty for non-choice fields. |
options[] | string | Each item | |
read_only_reason | JSON | Optional | |
read_only_reason (anyOf 1) | string | Alternative | PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable. Known values: PERMISSION_DENIED, RECORD_LOCKED, IMMUTABLE, MANAGED_OR_DERIVED, UNSUPPORTED_EDITOR, MASKED, REFERENCE_UNAVAILABLE |
read_only_reason (anyOf 2) | null | Alternative | |
reference_object | JSON | Optional | |
reference_object (anyOf 1) | string | Alternative | Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets. |
reference_object (anyOf 2) | null | Alternative | |
required | boolean | Required within parent | Whether a nonempty value is required by the field schema. |
value | JSON | Required within parent | |
value (anyOf 1) | string | Alternative | Calendar date in YYYY-MM-DD format, for example 2026-10-24; null unless value_state is PRESENT. Format: date |
value (anyOf 2) | null | Alternative | |
value_state | string | Required within parent | PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array. Known values: PRESENT, EMPTY, MASKED, UNSUPPORTED |
Retrieve record details — response body — fields / value / data_type: DATETIME, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A readable record field and the caller's ability to edit it. |
api_name | string | Required within parent | Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only. |
data_type | string | Required within parent | DATETIME contains an instant and is read-only in this release. Known values: DATETIME |
editable | boolean | Required within parent | Whether this caller can edit this field on this record. |
label | string | Required within parent | Field display name. |
multiple | boolean | Required within parent | Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references. |
options | array | Required within parent | Configured choice values; empty for non-choice fields. |
options[] | string | Each item | |
read_only_reason | JSON | Optional | |
read_only_reason (anyOf 1) | string | Alternative | PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable. Known values: PERMISSION_DENIED, RECORD_LOCKED, IMMUTABLE, MANAGED_OR_DERIVED, UNSUPPORTED_EDITOR, MASKED, REFERENCE_UNAVAILABLE |
read_only_reason (anyOf 2) | null | Alternative | |
reference_object | JSON | Optional | |
reference_object (anyOf 1) | string | Alternative | Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets. |
reference_object (anyOf 2) | null | Alternative | |
required | boolean | Required within parent | Whether a nonempty value is required by the field schema. |
value | JSON | Required within parent | |
value (anyOf 1) | string | Alternative | ISO 8601 timestamp with timezone, normalized to UTC; null unless value_state is PRESENT. Format: date-time |
value (anyOf 2) | null | Alternative | |
value_state | string | Required within parent | PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array. Known values: PRESENT, EMPTY, MASKED, UNSUPPORTED |
Retrieve record details — response body — fields / value / data_type: NUMBER, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A readable record field and the caller's ability to edit it. |
api_name | string | Required within parent | Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only. |
data_type | string | Required within parent | NUMBER contains a decimal quantity. Known values: NUMBER |
editable | boolean | Required within parent | Whether this caller can edit this field on this record. |
label | string | Required within parent | Field display name. |
multiple | boolean | Required within parent | Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references. |
options | array | Required within parent | Configured choice values; empty for non-choice fields. |
options[] | string | Each item | |
read_only_reason | JSON | Optional | |
read_only_reason (anyOf 1) | string | Alternative | PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable. Known values: PERMISSION_DENIED, RECORD_LOCKED, IMMUTABLE, MANAGED_OR_DERIVED, UNSUPPORTED_EDITOR, MASKED, REFERENCE_UNAVAILABLE |
read_only_reason (anyOf 2) | null | Alternative | |
reference_object | JSON | Optional | |
reference_object (anyOf 1) | string | Alternative | Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets. |
reference_object (anyOf 2) | null | Alternative | |
required | boolean | Required within parent | Whether a nonempty value is required by the field schema. |
value | JSON | Required within parent | |
value (anyOf 1) | string | Alternative | Decimal quantity encoded as a string to preserve precision, for example 12.50. Units follow the configured field's meaning. Null unless value_state is PRESENT. Pattern: ^[+-]?(?:\d+(?:\.\d*)?|\.\d+)(?:[eE][+-]?\d+)?$ |
value (anyOf 2) | null | Alternative | |
value_state | string | Required within parent | PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array. Known values: PRESENT, EMPTY, MASKED, UNSUPPORTED |
Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A readable record field and the caller's ability to edit it. |
api_name | string | Required within parent | Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only. |
data_type | string | Required within parent | OG_REFERENCE_FIELD identifies a reference to the collection in reference_object, including standard owner and audit Worker references. Known values: OG_REFERENCE_FIELD |
editable | boolean | Required within parent | Whether this caller can edit this field on this record. |
label | string | Required within parent | Field display name. |
multiple | boolean | Required within parent | Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references. |
options | array | Required within parent | Configured choice values; empty for non-choice fields. |
options[] | string | Each item | |
read_only_reason | JSON | Optional | |
read_only_reason (anyOf 1) | string | Alternative | PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable. Known values: PERMISSION_DENIED, RECORD_LOCKED, IMMUTABLE, MANAGED_OR_DERIVED, UNSUPPORTED_EDITOR, MASKED, REFERENCE_UNAVAILABLE |
read_only_reason (anyOf 2) | null | Alternative | |
reference_object | JSON | Optional | |
reference_object (anyOf 1) | string | Alternative | Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets. |
reference_object (anyOf 2) | null | Alternative | |
required | boolean | Required within parent | Whether a nonempty value is required by the field schema. |
value | JSON | Required within parent | Canonical relationship pair for reference_object: worker_id and expandable worker, or custom_object_record_id and expandable custom_object_record. Null unless PRESENT; masked references disclose no identifier or resource. |
value (anyOf 1) | Model | Alternative | Expand Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value worker, worker id |
value (anyOf 2) | Model | Alternative | Expand Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value custom object record, custom object record id |
value (anyOf 3) | JSON | Alternative | |
value (anyOf 3) (anyOf 1) | string | Alternative | |
value (anyOf 3) (anyOf 2) | null | Alternative | |
value_state | string | Required within parent | PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array. Known values: PRESENT, EMPTY, MASKED, UNSUPPORTED |
Referenced models: Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value custom object record, custom object record id, Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value worker, worker id
Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value custom object record, custom object record id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A canonical Custom Object record relationship, including its dynamic fields. |
custom_object_record | JSON | Optional | Exact canonical Custom Object record response, including readable dynamic fields; included with expand=fields.value.custom_object_record. Null when not expanded or unavailable under target permissions. |
custom_object_record (anyOf 1) | Model | Alternative | Expand Retrieve a specific custom object record — response body |
custom_object_record (anyOf 2) | JSON | Alternative | |
custom_object_record (anyOf 2) (anyOf 1) | string | Alternative | |
custom_object_record (anyOf 2) (anyOf 2) | null | Alternative | |
custom_object_record_id | string | Required within parent | Canonical record identifier in reference_object. Retrieve it through GET /custom-objects/{reference_object}/records/{custom_object_record_id}/; PATCH accepts this identifier. |
Referenced models: Retrieve a specific custom object record — response body
Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value worker, worker id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A canonical Worker relationship; Worker facts belong to its expansion. |
worker | JSON | Optional | Exact canonical Worker response, included with expand=fields.value.worker or fields.value.worker.user. Null when not expanded or unavailable under target permissions. |
worker (anyOf 1) | Model | Alternative | Expand Retrieve a specific worker — response body — manager |
worker (anyOf 2) | JSON | Alternative | |
worker (anyOf 2) (anyOf 1) | string | Alternative | |
worker (anyOf 2) (anyOf 2) | null | Alternative | |
worker_id | string | Required within parent | Canonical Worker identifier accepted by the Custom Object record PATCH endpoint. Retrieve it through GET /workers/{worker_id}/. |
Referenced models: Retrieve a specific worker — response body — manager
Retrieve record details — response body — fields / value / data_type: RADIO, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A readable record field and the caller's ability to edit it. |
api_name | string | Required within parent | Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only. |
data_type | string | Required within parent | RADIO contains one configured choice. Known values: RADIO |
editable | boolean | Required within parent | Whether this caller can edit this field on this record. |
label | string | Required within parent | Field display name. |
multiple | boolean | Required within parent | Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references. |
options | array | Required within parent | Configured choice values; empty for non-choice fields. |
options[] | string | Each item | |
read_only_reason | JSON | Optional | |
read_only_reason (anyOf 1) | string | Alternative | PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable. Known values: PERMISSION_DENIED, RECORD_LOCKED, IMMUTABLE, MANAGED_OR_DERIVED, UNSUPPORTED_EDITOR, MASKED, REFERENCE_UNAVAILABLE |
read_only_reason (anyOf 2) | null | Alternative | |
reference_object | JSON | Optional | |
reference_object (anyOf 1) | string | Alternative | Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets. |
reference_object (anyOf 2) | null | Alternative | |
required | boolean | Required within parent | Whether a nonempty value is required by the field schema. |
value | JSON | Required within parent | |
value (anyOf 1) | string | Alternative | One value from options; null unless value_state is PRESENT. |
value (anyOf 2) | null | Alternative | |
value_state | string | Required within parent | PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array. Known values: PRESENT, EMPTY, MASKED, UNSUPPORTED |
Retrieve record details — response body — fields / value / data_type: SELECT, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A readable record field and the caller's ability to edit it. |
api_name | string | Required within parent | Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only. |
data_type | string | Required within parent | SELECT contains zero or more configured choices. Known values: SELECT |
editable | boolean | Required within parent | Whether this caller can edit this field on this record. |
label | string | Required within parent | Field display name. |
multiple | boolean | Required within parent | Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references. |
options | array | Required within parent | Configured choice values; empty for non-choice fields. |
options[] | string | Each item | |
read_only_reason | JSON | Optional | |
read_only_reason (anyOf 1) | string | Alternative | PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable. Known values: PERMISSION_DENIED, RECORD_LOCKED, IMMUTABLE, MANAGED_OR_DERIVED, UNSUPPORTED_EDITOR, MASKED, REFERENCE_UNAVAILABLE |
read_only_reason (anyOf 2) | null | Alternative | |
reference_object | JSON | Optional | |
reference_object (anyOf 1) | string | Alternative | Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets. |
reference_object (anyOf 2) | null | Alternative | |
required | boolean | Required within parent | Whether a nonempty value is required by the field schema. |
value | JSON | Required within parent | |
value (anyOf 1) | array | Alternative | Selected values from options. An empty selection is []; null unless value_state is PRESENT. |
value (anyOf 1)[] | string | Each item | |
value (anyOf 2) | null | Alternative | |
value_state | string | Required within parent | PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array. Known values: PRESENT, EMPTY, MASKED, UNSUPPORTED |
Retrieve record details — response body — fields / value / data_type: TEXT, LONG TEXT, EMAIL, URL, PHONE NUMBER, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A readable record field and the caller's ability to edit it. |
api_name | string | Required within parent | Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only. |
data_type | string | Required within parent | TEXT and LONG_TEXT contain text; EMAIL, URL, and PHONE_NUMBER contain their respective textual values. Known values: TEXT, LONG_TEXT, EMAIL, URL, PHONE_NUMBER |
editable | boolean | Required within parent | Whether this caller can edit this field on this record. |
label | string | Required within parent | Field display name. |
multiple | boolean | Required within parent | Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references. |
options | array | Required within parent | Configured choice values; empty for non-choice fields. |
options[] | string | Each item | |
read_only_reason | JSON | Optional | |
read_only_reason (anyOf 1) | string | Alternative | PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable. Known values: PERMISSION_DENIED, RECORD_LOCKED, IMMUTABLE, MANAGED_OR_DERIVED, UNSUPPORTED_EDITOR, MASKED, REFERENCE_UNAVAILABLE |
read_only_reason (anyOf 2) | null | Alternative | |
reference_object | JSON | Optional | |
reference_object (anyOf 1) | string | Alternative | Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets. |
reference_object (anyOf 2) | null | Alternative | |
required | boolean | Required within parent | Whether a nonempty value is required by the field schema. |
value | JSON | Required within parent | |
value (anyOf 1) | string | Alternative | Readable text, or null unless value_state is PRESENT. |
value (anyOf 2) | null | Alternative | |
value_state | string | Required within parent | PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array. Known values: PRESENT, EMPTY, MASKED, UNSUPPORTED |
Retrieve record details — response body — fields / value / value_state: PRESENT, EMPTY, MASKED, UNSUPPORTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A readable record field and the caller's ability to edit it. |
api_name | string | Required within parent | Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only. |
data_type | string | Required within parent | These specialized types have no public value representation in this release. UNSUPPORTED also covers unrecognized source types. Values are withheld and editing is unavailable. Known values: PERCENTAGE, ADDRESS, TIMESTAMPED_CURRENCY, NATIVE_EDGE, REFERENCE_ID, TIME, FILE, JSONB, COORDINATE, UNSUPPORTED |
editable | boolean | Required within parent | Whether this caller can edit this field on this record. |
label | string | Required within parent | Field display name. |
multiple | boolean | Required within parent | Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references. |
options | array | Required within parent | Configured choice values; empty for non-choice fields. |
options[] | string | Each item | |
read_only_reason | JSON | Optional | |
read_only_reason (anyOf 1) | string | Alternative | PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable. Known values: PERMISSION_DENIED, RECORD_LOCKED, IMMUTABLE, MANAGED_OR_DERIVED, UNSUPPORTED_EDITOR, MASKED, REFERENCE_UNAVAILABLE |
read_only_reason (anyOf 2) | null | Alternative | |
reference_object | JSON | Optional | |
reference_object (anyOf 1) | string | Alternative | Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets. |
reference_object (anyOf 2) | null | Alternative | |
required | boolean | Required within parent | Whether a nonempty value is required by the field schema. |
value | JSON | Required within parent | |
value (anyOf 1) | string | Alternative | Always null because this field type is unsupported. |
value (anyOf 2) | null | Alternative | |
value_state | string | Required within parent | PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array. Known values: PRESENT, EMPTY, MASKED, UNSUPPORTED |
Retrieve record details — response body — layout
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Effective saved page layout. |
api_name | string | Required within parent | Resolved saved layout API name. |
header | Model | Required within parent | Expand Retrieve record details — response body — layout header |
revision | string | Required within parent | Opaque revision of the effective, permission-filtered layout. Compare to detect layout changes; this is not the record write version. |
tabs | array | Required within parent | Ordered, visible tabs. |
tabs[] | Model | Each item | Expand Retrieve record details — response body — layout tabs item |
Referenced models: Retrieve record details — response body — layout header, Retrieve record details — response body — layout tabs item
Retrieve record details — response body — layout header
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Semantic record header. |
description_field | JSON | Optional | |
description_field (anyOf 1) | string | Alternative | Description field API name, or null when unavailable. |
description_field (anyOf 2) | null | Alternative | |
fields | array | Required within parent | Ordered summary field API names. |
fields[] | string | Each item | |
title_field | JSON | Optional | |
title_field (anyOf 1) | string | Alternative | Title field API name, or null when unavailable. |
title_field (anyOf 2) | null | Alternative |
Retrieve record details — response body — layout tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Ordered, visible tab of sections in the effective record page layout. |
id | string | Required within parent | Stable tab identifier. |
label | string | Required within parent | Tab display name. |
sections | array | Required within parent | Ordered, visible sections. |
sections[] | Model | Each item | Expand Retrieve record details — response body — layout tabs item sections item |
Referenced models: Retrieve record details — response body — layout tabs item sections item
Retrieve record details — response body — layout tabs item sections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Visible group of field placements, a deferred related list, or explicitly unsupported content. |
columns | JSON | Required within parent | |
columns (anyOf 1) | integer | Alternative | Suggested field columns; clients may adapt to available space. |
columns (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fields | array | Required within parent | Ordered placements for a FIELDS section. Empty for RELATED_LIST and UNSUPPORTED sections. |
fields[] | Model | Each item | Expand Retrieve record details — response body — layout tabs item sections item fields item |
id | string | Required within parent | Section identifier scoped to the effective layout. Use a RELATED_LIST section's records_link to retrieve its records. |
label | string | Required within parent | Section display name. |
object_api_name | JSON | Optional | |
object_api_name (anyOf 1) | string | Alternative | Related Custom Object API name; null for other sections. |
object_api_name (anyOf 2) | null | Alternative | |
reason | JSON | Optional | |
reason (anyOf 1) | string | Alternative | CONTENT_NOT_SUPPORTED means this section requires a renderer outside this API; RELATED_OBJECT_NOT_SUPPORTED means the related list targets a native object, which this release cannot render. Null for supported field and Custom Object related-list sections. Known values: CONTENT_NOT_SUPPORTED, RELATED_OBJECT_NOT_SUPPORTED |
reason (anyOf 2) | null | Alternative | |
records_link | JSON | Optional | |
records_link (anyOf 1) | string | Alternative | Authorized related-record collection URL, including the resolved layout; null for other sections. |
records_link (anyOf 2) | null | Alternative | |
type | string | Required within parent | FIELDS contains ordered field placements; RELATED_LIST describes records loaded through records_link; UNSUPPORTED identifies visible content this API cannot render. Known values: FIELDS, RELATED_LIST, UNSUPPORTED |
Referenced models: Retrieve record details — response body — layout tabs item sections item fields item
Retrieve record details — response body — layout tabs item sections item fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Placement of a readable field in a saved layout; contains no field value. |
field | string | Required within parent | Field API name in the response fields map. |
read_only | boolean | Required within parent | Whether this placement is read-only. |
Set or clear the company's default list view — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The shared saved view to use as a Custom Object's company default, or null to clear it. Additional keys: not allowed |
view_api_name | JSON | Required within parent | |
view_api_name (anyOf 1) | string | Alternative | Shared view API name; null clears the company default. |
view_api_name (anyOf 2) | null | Alternative |
Trigger a report run — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
filters | JSON | Optional | |
filters (anyOf 1) | array | Alternative | Optional list of filters to apply when running the report Default: null |
filters (anyOf 1)[] | Model | Each item | Expand Trigger a report run — request body — body filters array item |
filters (anyOf 2) | null | Alternative | |
format_currency_fields | JSON | Optional | |
format_currency_fields (anyOf 1) | JSON | Alternative | Formatting options for currency fields Default: null |
format_currency_fields (anyOf 1) (anyOf 1) | object | Alternative | |
format_currency_fields (anyOf 1) (anyOf 1).columns | string | Required within parent | Currency column format for currency fields One of: TYPE_AND_AMOUNT, VALUE_ONLY |
format_currency_fields (anyOf 1) (anyOf 1).currency_type | JSON | Optional | |
format_currency_fields (anyOf 1) (anyOf 1).currency_type (anyOf 1) | string | Alternative | Currency type (e.g., 'USD') |
format_currency_fields (anyOf 1) (anyOf 1).currency_type (anyOf 2) | null | Alternative | |
format_currency_fields (anyOf 1) (anyOf 2) | null | Alternative | |
format_currency_fields (anyOf 2) | null | Alternative | |
format_date_fields | JSON | Optional | |
format_date_fields (anyOf 1) | JSON | Alternative | Formatting options for date fields Default: null |
format_date_fields (anyOf 1) (anyOf 1) | object | Alternative | |
format_date_fields (anyOf 1) (anyOf 1).date_format | string | Required within parent | Date format for date fields in the report output One of: ISO_8601, APPLY_VISUALIZATION_SETTINGS |
format_date_fields (anyOf 1) (anyOf 1).datetime_timezone | JSON | Optional | |
format_date_fields (anyOf 1) (anyOf 1).datetime_timezone (anyOf 1) | string | Alternative | Timezone for datetime fields (e.g., 'America/Los_Angeles') |
format_date_fields (anyOf 1) (anyOf 1).datetime_timezone (anyOf 2) | null | Alternative | |
format_date_fields (anyOf 1) (anyOf 2) | null | Alternative | |
format_date_fields (anyOf 2) | null | Alternative | |
include_object_ids | boolean | Optional | Whether to include object IDs in the report output Default: false |
include_total_rows | boolean | Optional | Whether to include total row count in the report output Default: false |
output_type | string | Optional | Output format for the report data Default: JSON One of: JSON, CSV |
report_id | string | Required within parent | The ID of the report to run |
view_as | string | Optional | Controls whose permissions are used when running the report. VIEWER (default) uses the API token owner's own permissions. OWNER uses the report owner's permissions (requires owner-level access to the report). Default: VIEWER One of: VIEWER, OWNER |
Referenced models: Trigger a report run — request body — body filters array item
Trigger a report run — request body — body filters array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single filter to apply when running a report. The expected shape of 'value' depends on the operator — see the FilterOperator description for details. |
field_id | string | Required within parent | The ID of the report field to filter on |
operator | string | Required within parent | Comparison operator for the filter. Single-value operators (EQ, NE, GT, GTE, LT, LTE, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS, BEFORE, AFTER) require a scalar value. List operators (IN, NOT_IN) require a non-empty array. Range operators (BETWEEN, NOT_BETWEEN) require an object with 'from' and 'to' keys. No-value operators (IS_EMPTY, IS_NOT_EMPTY) do not require a value. Rolling-date operators (LAST_N, NEXT_N) require an object with 'unit' (DAY, WEEK, MONTH, YEAR) and 'n' (integer). Calendar-date operators (CURRENT_CALENDAR, PREVIOUS_CALENDAR) require a unit string (DAY, WEEK, MONTH, QUARTER, YEAR). One of: EQ, NE, IN, NOT_IN, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS, GT, GTE, LT, LTE, BETWEEN, NOT_BETWEEN, IS_EMPTY, IS_NOT_EMPTY, BEFORE, AFTER, LAST_N, NEXT_N, CURRENT_CALENDAR, PREVIOUS_CALENDAR |
value | JSON | Optional | |
value (anyOf 1) | JSON | Alternative | The filter value. Shape depends on the operator: scalar for single-value operators; array for list operators; RangeValue object ({from, to}) for range operators; RollingDateValue object ({unit, n}) for rolling-date operators; unit string for calendar-date operators; omitted or null for IS_EMPTY/IS_NOT_EMPTY. |
value (anyOf 1) (oneOf 1) | string | Alternative | |
value (anyOf 1) (oneOf 2) | number | Alternative | |
value (anyOf 1) (oneOf 3) | boolean | Alternative | |
value (anyOf 1) (oneOf 4) | array | Alternative | |
value (anyOf 1) (oneOf 5) | Model | Alternative | Expand Trigger a report run — request body — body filters array item value value from, to |
value (anyOf 1) (oneOf 6) | Model | Alternative | Expand Trigger a report run — request body — body filters array item value value n, unit |
value (anyOf 2) | null | Alternative |
Referenced models: Trigger a report run — request body — body filters array item value value from, to, Trigger a report run — request body — body filters array item value value n, unit
Trigger a report run — request body — body filters array item value value from, to
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Range bounds for 'between' and 'not_between' operators |
Trigger a report run — request body — body filters array item value value n, unit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Rolling date window for 'last_n' and 'next_n' operators |
Update a Custom App — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
api_name | string | Required within parent | The unique api name of the custom app |
description | string | Optional | The description of the custom app |
name | string | Required within parent | The display name of the custom app |
Update a Custom App — response body — pages item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Summary of a page attached to a custom app. |
api_name | string | Optional | The unique name of the page within the app |
canvas_instance_id | string | Optional | The ID of the canvas instance backing this page (canvas_page only) |
created_by | string | Optional | The ID of the role that created the page |
function_id | string | Optional | The ID of the Rippling Function rendering this page (sdui_page only) |
page_type | string | Optional | The type of page (e.g. 'canvas_page', 'sdui_page', 'object_page') |
sdui_page_id | string | Optional | The ID of the SDUI page instance (sdui_page only) |
updated_by | string | Optional | The ID of the role that last modified the page |
Update a Custom Page — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
function_id | string | Optional | The ID of the Rippling Function that renders this page |
name | string | Optional | The display name of the custom page |
Update a Setting — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
api_name | string | Optional | The unique api name of the setting |
boolean_value | boolean | Optional | Boolean value of the setting, if it has boolean data type |
data_type | string | Optional | Data type of the setting |
display_name | string | Optional | The display name of setting |
number_value | number | Optional | Number value of the setting, if it has number data type |
secret_value | string | Optional | Secret value of the setting, if it has secret data type |
string_value | string | Optional | String value of the setting, if it has string data type |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | |
value (anyOf 2) | number | Alternative | |
value (anyOf 3) | boolean | Alternative |
Update a background check candidate — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Background Check Candidate DTO. Represents a candidate who has been submitted for background check screening. Required on Create (but nullable on read for legacy rows): - email: Required for new candidates, but may be null on read for legacy rows - external_id: Required for new candidates, but may be null on read for legacy rows Optional Fields: - owner_id: May be null if no provider is associated - first_name: May be null if name is not available - last_name: May be null if name is not available - middle_name: May be null if not provided Sensitive Fields: - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model - These do not require separate OAuth scopes beyond the resource-level scopes (background-check-candidates.read / .read-write) because they are not updating role or worker data, only storing candidate names for background check processing Note: first_name, last_name, and middle_name are NOT filterable. Only external_id, email, created_at, and updated_at support filtering. |
email | string | Required within parent | The email address of the candidate. Required on create, but may be null on read for legacy rows. |
external_id | string | Required within parent | The provider's unique identifier for the candidate. Required on create, but may be null on read for legacy rows. Can only be set once (during creation or when null). Cannot be changed after being set. |
first_name | string | Optional | The first name of the candidate. |
last_name | string | Optional | The last name of the candidate. |
middle_name | string | Optional | The middle name of the candidate. |
Update a custom object list view — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Changes to a saved grid definition; omitted properties retain their saved values. Minimum fields: 1 Additional keys: not allowed |
columns | array | Optional | Ordered, nonempty, unique field selection. |
columns[] | Model | Each item | Expand Create a custom object list view — request body — body columns item |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Creator-provided explanation of the records or purpose of this saved view. Null clears the explanation; omission preserves it. |
description (anyOf 2) | null | Alternative | |
name | string | Optional | Nonblank display name. |
order_by | JSON | Optional | |
order_by (anyOf 1) | string | Alternative | One sortable field API name, a space, and lowercase asc or desc, for example name asc. Null clears saved ordering. |
order_by (anyOf 2) | null | Alternative | |
query | JSON | Optional | |
query (anyOf 1) | string | Alternative | Saved RQL predicate; null clears it. |
query (anyOf 2) | null | Alternative | |
record_scope | string | Optional | ALL includes all records the caller may read; MY_RECORDS restricts owners to the authenticated requester when the view is used. Omission preserves the saved scope. One of: ALL, MY_RECORDS |
visibility | string | Optional | PRIVATE belongs to its creator; SHARED is visible within the company. Neither grants record access. Shared views cannot become private. Omission preserves visibility. One of: PRIVATE, SHARED |
Referenced models: Create a custom object list view — request body — body columns item
Update a custom object record — response body — data created at, id, name, updated at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: see wildcard field |
$.* | JSON | Additional keys |
Update a department — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The name of the department. |
parent_id | string | Optional | The parent department. |
reference_code | string | Optional | Reference code of the department. |
Update a department — response body — parent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
department_hierarchy | array | Optional | List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order. Expandable field |
department_hierarchy[] | Model | Each item | Expand Update a department — response body — parent |
department_hierarchy_id | array | Optional | The identifier of departments in the department hierarchy ordered from parent department to child department. |
department_hierarchy_id[] | string | Each item | |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the department. |
parent | Model | Optional | Expand Update a department — response body — parent The parent department. Expandable field |
parent_id | string | Optional | The parent department. |
reference_code | string | Optional | Reference code of the department. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a department — response body — parent
Update a function — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code_draft | string | Optional | The current draft of code for the function |
dependencies | object | Optional | The dependencies of the function |
description | string | Optional | The function description |
listed_in_custom_apps | boolean | Optional | Whether this request-function is listed in the Custom Apps grid and navigation. Defaults to false on creation; omitted updates preserve the current value. Listing does not grant access or change deployment behavior. Only supported for request functions. Setting this field on an event function returns a validation error. |
name | string | Optional | The function name |
source_upload | object | Optional | Optional source ZIP checksum and size for request functions only. Create or update returns ephemeral source_upload_instructions; this input is not returned. |
source_upload.sha256 | string | Required within parent | SHA-256 of the exact ZIP bytes, written as 64 lowercase hexadecimal characters. |
source_upload.size_bytes | integer | Required within parent | Exact ZIP size in bytes, from 1 through 67108864 (64 MiB). |
Update a function — response body — source upload instructions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Upload instructions returned only when source_upload was requested on create or update. |
archive | Model | Required within parent | Expand Update a function — response body — source upload instructions archive |
expires_at | string | Required within parent | UTC expiration of the upload instructions, in RFC3339/ISO8601 format. |
fields | object | Required within parent | Include every opaque signed field unchanged in the multipart/form-data POST, plus the ZIP file. Additional keys: see wildcard field |
fields.* | string | Additional keys | |
method | string | Required within parent | HTTP method for the client-direct upload. Known values: POST |
url | string | Required within parent | Upload the ZIP directly to this URL, not through the Functions API. |
Referenced models: Update a function — response body — source upload instructions archive
Update a function — response body — source upload instructions archive
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Archive reference for a subsequent deployment after the upload succeeds. |
object_key | string | Required within parent | Tenant-scoped object key to use as the archive reference in the explicit deployment JSON. |
sha256 | string | Required within parent | SHA-256 of the ZIP bytes. |
size_bytes | JSON | Required within parent | |
size_bytes (anyOf 1) | integer | Alternative | Exact ZIP size in bytes, returned as a JSON integer. |
size_bytes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update a job assignment — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
change_reason | string | Optional | Reason recorded on the change (e.g., the reason for scheduling an unassignment). |
effective_from | string | Optional | Date and time the change becomes effective (ISO 8601 format, e.g., 2025-11-07T17:00:00.000+00:00); defaults to current time in UTC if not provided. job_pay_rate_effective_from is ignored if this field is provided. |
job_code_id | string | Optional | Identifier of job that is assigned to worker |
job_pay_rate | number | Optional | The pay rate for job assigned to worker. This can be different from the job's standard pay rate and can be overriden for a worker. |
job_pay_rate_change_reason | string | Optional | This field is deprecated and will be removed in a future version, use the new change_reason field instead. |
job_pay_rate_effective_from | string | Optional | This field is deprecated and will be removed in a future version, use the new effective_from field instead. |
worker_id | string | Optional | Identifier of worker to whom job is assigned. |
Update a job assignment — response body — job code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job that is assigned to worker Expandable field |
created_at | string | Required within parent | Record creation date |
custom_location | Model | Optional | Expand Update a job code — response body — custom location |
department | Model | Optional | Expand Update a job code — response body — department |
department_id | string | Optional | The department associated with the job code. |
external_id | string | Optional | The unique identifier of the job code in an outside system. |
group_id | string | Optional | The ID of the job roster group. |
id | string | Required within parent | Identifier field |
is_archived | boolean | Optional | Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API. |
job_dimension | Model | Optional | Expand Update a job code — response body — job dimension |
job_dimension_id | string | Required within parent | The ID of the job dimension this job code belongs to. |
name | string | Required within parent | The name of the job dimension. |
pay_rate | JSON | Optional | |
pay_rate (anyOf 1) | number | Alternative | The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute. |
pay_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pay_rate_exceptions | array | Optional | Pay rate overrides for the job based on exception dimension values. Expandable field |
pay_rate_exceptions[] | Model | Each item | Expand Update a job code — response body — pay rate exceptions item |
pay_rate_exceptions_id | array | Optional | Pay rate overrides id for the job based on exception dimension values. |
pay_rate_exceptions_id[] | string | Each item | |
updated_at | string | Required within parent | Record update date |
work_location | Model | Optional | Expand Update a job code — response body — work location |
work_location_id | string | Optional | The work location associated with the job code. |
Referenced models: Update a job code — response body — pay rate exceptions item, Update a job code — response body — custom location, Update a job code — response body — department, Update a job code — response body — job dimension, Update a job code — response body — work location
Update a job assignment — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker to whom job is assigned. Expandable field |
business_partners | array | Optional | Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners. Expandable field |
business_partners[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
business_partners_id[] | string | Each item | |
citizenship | string | Optional | The countries that the worker has citizenship in. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
compensation_grade.label | string | Optional | The compensation grade's label. |
compensation_id | string | Optional | The compensation package for the worker. |
country | string | Optional | The worker's country. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
country_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
date_of_birth | string | Optional | The worker's date of birth. |
department | Model | Optional | Expand Retrieve a specific worker — response body — department |
department_id | string | Optional | The worker's assigned department. |
employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
employment_type_id | string | Optional | The worker's employment type. |
end_date | string | Optional | The end date of the worker. |
ethnicity | string | Optional | The identified ethnicity of the worker, if specified. Known values: HISPANIC_OR_LATINO, WHITE, BLACK_OR_AFRICAN_AMERICAN, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, ASIAN, AMERICAN_INDIAN_OR_ALASKA_NATIVE, TWO_OR_MORE_RACES, MIDDLE_EASTERN_OR_NORTH_AFRICAN, DECLINE_TO_SELF_IDENTIFY, AFRICAN, COLOURED, INDIAN, OTHER, PREFER_NOT_TO_SAY |
gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
id | string | Required within parent | Identifier field |
is_manager | boolean | Optional | Whether the worker is a manager |
job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
job_function.created_at | string | Required within parent | Record creation date |
job_function.id | string | Required within parent | Identifier field |
job_function.name | string | Optional | Displayed name of the job function |
job_function.updated_at | string | Required within parent | Record update date |
job_function_id | string | Optional | ID of the worker's job function. |
legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
legal_entity_id | string | Optional | The worker's associated legal entity. |
level | Model | Optional | Expand Retrieve a specific worker — response body — level |
level_id | string | Optional | The level of the worker. |
location | object | Optional | The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote. |
location.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
manager_id | string | Optional | The worker's manager. |
number | JSON | Optional | |
number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
personal_email | string | Optional | The worker's associated personal email address. |
race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
start_date | string | Optional | The start date of the worker. |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
teams | array | Optional | The worker's assigned teams. Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | The worker's assigned teams. |
teams_id[] | string | Each item | |
termination_details | object | Optional | The details of the worker's termination, if applicable. |
termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
title | string | Optional | The worker's title. |
title_effective_date | string | Optional | Title effective date |
updated_at | string | Required within parent | Record update date |
user | Model | Optional | Expand Retrieve a specific worker — response body — user |
user_id | string | Optional | The worker's associated user. |
work_email | string | Optional | The worker's associated work email address. |
work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
work_schedule.* | Model | Additional keys | Expand Retrieve a specific worker — response body — work schedule value |
Referenced models: Retrieve a specific worker — response body — business partners item, Update a team — response body — parent, Retrieve a specific worker — response body — work schedule value, Retrieve a specific worker — response body — manager, Retrieve a specific worker — response body — compensation, Retrieve a specific worker — response body — country fields, Retrieve a specific worker — response body — department, Retrieve a specific worker — response body — employment type, Retrieve a specific worker — response body — legal entity, Retrieve a specific worker — response body — level, Retrieve a specific worker — response body — user
Update a job code — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_location | Model | Optional | Expand Update a job code — request body — body custom location |
external_id | string | Optional | The unique identifier of the job code in an outside system. |
is_archived | boolean | Optional | Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API. |
job_dimension_id | string | Optional | The ID of the job dimension this job code belongs to. |
name | string | Optional | The name of the job dimension. |
pay_rate | number | Optional | The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute. |
pay_rate_change_reason | string | Optional | Reason for setting, updating, or resetting the pay rate on this job code. |
pay_rate_effective_from | string | Optional | Date and time the pay rate becomes effective (ISO 8601 format YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to current time in UTC if not provided. |
Referenced models: Update a job code — request body — body custom location
Update a job code — request body — body custom location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code. |
address | Model | Required within parent | Expand Update a job code — request body — body custom location address |
Referenced models: Update a job code — request body — body custom location address
Update a job code — request body — body custom location address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The address of the custom location. |
country | string | Optional | The country component, pursuant to SCIM RFC 7643 4.1.2. One of: 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 |
locality | string | Optional | The city or locality component. |
postal_code | string | Optional | The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2. |
region | string | Optional | The state or region component, pursuant to SCIM RFC 7643 4.1.2. |
street_address | string | Optional | The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2.. |
type | string | Optional | The classification of the address. One of: HOME, WORK, OTHER |
Update a job code — response body — custom location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code. |
address | Model | Required within parent | Expand Update a job code — response body — custom location address |
Referenced models: Update a job code — response body — custom location address
Update a job code — response body — custom location address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The address of the custom location. |
country | string | Optional | The country component, pursuant to SCIM RFC 7643 4.1.2. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
formatted | string | Optional | The formatted mailing address. |
locality | string | Optional | The city or locality component. |
postal_code | string | Optional | The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2. |
region | string | Optional | The state or region component, pursuant to SCIM RFC 7643 4.1.2. |
street_address | string | Optional | The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2.. |
type | string | Optional | The classification of the address. Known values: HOME, WORK, OTHER |
Update a job code — response body — department
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The department associated with the job code. Expandable field |
created_at | string | Required within parent | Record creation date |
department_hierarchy | array | Optional | List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order. Expandable field |
department_hierarchy[] | Model | Each item | Expand Update a department — response body — parent |
department_hierarchy_id | array | Optional | The identifier of departments in the department hierarchy ordered from parent department to child department. |
department_hierarchy_id[] | string | Each item | |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the department. |
parent | Model | Optional | Expand Update a department — response body — parent The parent department. Expandable field |
parent_id | string | Optional | The parent department. |
reference_code | string | Optional | Reference code of the department. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a department — response body — parent
Update a job code — response body — job dimension
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The job dimension this job code belongs to. Expandable field |
created_at | string | Required within parent | Record creation date |
external_id | string | Optional | The unique identifier of the job dimension in a third party system |
group_id | string | Optional | The ID of the dimension roster group. |
id | string | Required within parent | Identifier field |
includes_custom_location | boolean | Optional | Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true. |
name | string | Required within parent | The name of the job dimension |
org_attribute_associations | array | Optional | Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests. |
org_attribute_associations[] | JSON | Each item | Known values: DEPARTMENT, WORK_LOCATION, PAY_RATE, ENTITY |
roster_type | string | Optional | The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group. Known values: PER_DIMENSION, PER_JOB_CODE |
updated_at | string | Required within parent | Record update date |
Update a job code — response body — pay rate exceptions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
exception_dimension_id | string | Required within parent | Identifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource |
exception_dimension_type | string | Optional | Type of dimension on which exception is configured Known values: JOB_CODE, LEVEL, TEAM, DEPARTMENT, WORK_LOCATION |
id | string | Required within parent | Identifier field |
job_code | Model | Optional | Expand List job codes — response body — results item Job for which exception is configured. Expandable field |
job_code_id | string | Required within parent | Identifier of Job for which exception is configured. |
pay_rate | JSON | Required within parent | |
pay_rate (anyOf 1) | number | Alternative | The pay rate for exception on job_code_id and exception_dimension_id combination |
pay_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Record update date |
Referenced models: List job codes — response body — results item
Update a job code — response body — work location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The work location associated with the job code. Expandable field |
address | Model | Required within parent | Expand Update a work location — response body — address |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the work location. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a work location — response body — address
Update a job dimension — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_id | string | Optional | The unique identifier of the job dimension in a third party system |
includes_custom_location | boolean | Optional | Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true. |
name | string | Optional | The name of the job dimension |
org_attribute_associations | array | Optional | Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests. |
org_attribute_associations[] | JSON | Each item | One of: DEPARTMENT, WORK_LOCATION, PAY_RATE, ENTITY |
roster_type | string | Optional | The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group. One of: PER_DIMENSION, PER_JOB_CODE |
Update a kiosk badge — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
badge_id | string | Optional | The ID associated with the badge. Not to be confused with the record's ID. |
is_enabled | boolean | Optional | Whether this badge can be used with the Kiosk app. |
worker_id | string | Optional | The ID of the worker associated with the badge. |
worker_number | integer | Optional | The employee number of the worker associated with the badge. |