Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootThe compensation package for the worker.

Expandable field
annual_compensationobjectOptionalThe worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.
annual_compensation.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
annual_compensation.valueJSONOptional
annual_compensation.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
annual_compensation.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
annual_salary_equivalentobjectOptionalThe 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_typestringOptionalThe currency type, ex: USD, EUR, etc.
annual_salary_equivalent.valueJSONOptional
annual_salary_equivalent.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
annual_salary_equivalent.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
bonus_schedulestringOptionalThe worker's bonus schedule.
created_atstringRequired within parentRecord creation date
hourly_wageobjectOptionalThe worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.
hourly_wage.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
hourly_wage.valueJSONOptional
hourly_wage.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
hourly_wage.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentIdentifier field
monthly_compensationobjectOptionalThe worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.
monthly_compensation.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
monthly_compensation.valueJSONOptional
monthly_compensation.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
monthly_compensation.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
on_target_commissionobjectOptionalThe worker's on-target commission.
on_target_commission.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
on_target_commission.valueJSONOptional
on_target_commission.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
on_target_commission.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
payment_termsstringOptionalThe payment terms for an worker's compensation.
payment_typestringOptionalThe payment type for an worker's compensation.
relocation_reimbursementobjectOptionalThe worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.
relocation_reimbursement.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
relocation_reimbursement.valueJSONOptional
relocation_reimbursement.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
relocation_reimbursement.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
salary_effective_datestringOptionalSalary effective date
signing_bonusobjectOptionalThe worker's signing bonus.
signing_bonus.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
signing_bonus.valueJSONOptional
signing_bonus.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
signing_bonus.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
target_annual_bonusobjectOptionalThe worker's target annual bonus amount.
target_annual_bonus.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
target_annual_bonus.valueJSONOptional
target_annual_bonus.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
target_annual_bonus.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
target_annual_bonus_percentJSONOptional
target_annual_bonus_percent (anyOf 1)numberAlternativeThe worker's target annual bonus as a percent of annual compensation.
target_annual_bonus_percent (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentRecord update date
weekly_compensationobjectOptionalThe worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.
weekly_compensation.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
weekly_compensation.valueJSONOptional
weekly_compensation.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
weekly_compensation.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
workerModelOptionalExpand Retrieve a specific worker — response body — manager
The worker's details.

Expandable field
worker_idstringOptionalThe worker's ID.

Referenced models: Retrieve a specific worker — response body — manager

Retrieve a specific worker — response body — country fields

FieldTypePresenceDescription and constraints
$objectRootCountry level fields for the worker.
caobjectOptionalCountry-wise regional fields for Canada
ca.sinstringOptionalSocial Insurance Number (SIN) for Canada employees.
nzobjectOptionalCountry-wise regional fields for New Zealand
nz.ird_numberstringOptionalInland Revenue Department (IRD) number for New Zealand employees.
usobjectOptionalCountry-wise regional fields for USA
us.ssnstringOptionalSocial Security Number (SSN) for US employees.

Retrieve a specific worker — response body — department

FieldTypePresenceDescription and constraints
$objectRootThe worker's assigned department.

Expandable field
created_atstringRequired within parentRecord creation date
department_hierarchyarrayOptionalList of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.

Expandable field
department_hierarchy[]ModelEach itemExpand Update a department — response body — parent
department_hierarchy_idarrayOptionalThe identifier of departments in the department hierarchy ordered from parent department to child department.
department_hierarchy_id[]stringEach item
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the department.
parentModelOptionalExpand Update a department — response body — parent
The parent department.

Expandable field
parent_idstringOptionalThe parent department.
reference_codestringOptionalReference code of the department.
updated_atstringRequired within parentRecord update date

Referenced models: Update a department — response body — parent

Retrieve a specific worker — response body — employment type

FieldTypePresenceDescription and constraints
$objectRootThe worker's employment type.

Expandable field
amount_workedstringOptionalThe 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_periodstringOptionalThe 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_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
labelstringRequired within parentThe display label of the employment type.
namestringOptionalThe name of the employment type for non-custom employment types.
typestringOptionalThe 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_atstringRequired within parentRecord update date

Retrieve a specific worker — response body — legal entity

FieldTypePresenceDescription and constraints
$objectRootThe worker's associated legal entity.

Expandable field
companyModelOptionalExpand Retrieve a specific legal entity — response body — company
company_idstringOptionalThe company or organization associated with the legal entity
countryModelOptionalExpand Retrieve a specific legal entity — response body — country
created_atstringRequired within parentRecord creation date
entity_levelstringOptionalThe 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
idstringRequired within parentIdentifier field
legal_namestringOptionalThe legal name of the legal entity.
mailing_addressModelOptionalExpand Retrieve a specific legal entity — response body — mailing address
management_typestringOptionalThe 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
parentModelOptionalExpand Retrieve a specific legal entity — response body — parent
The parent legal entity.

Expandable field
parent_idstringOptionalThe parent legal entity.
physical_addressModelOptionalExpand Retrieve a specific legal entity — response body — physical address
registration_datestringOptionalThe registration date of the entity.
tax_identifierstringOptionalThe tax identifier for the legal entity.
updated_atstringRequired within parentRecord 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

FieldTypePresenceDescription and constraints
$objectRootThe level of the worker.

Expandable field
created_atstringRequired within parentRecord creation date
descriptionstringOptionalThe description of the level.
experience_requirementsstringOptionalThe experience requirements for the level.
global_levelJSONOptional
global_level (anyOf 1)integerAlternativeGlobal 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the level. Must be unique within the company or organization.
parentModelOptionalExpand Update a level — response body — parent
The parent level.

Expandable field
parent_idstringOptionalThe parent level.
rankJSONOptional
rank (anyOf 1)integerAlternativeThe rank of the level within its track.
rank (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
scope_of_responsibilitiesstringOptionalThe scope of responsibilities for the level.
trackModelOptionalExpand Update a level — response body — track
track_idstringOptionalThe track associated with the level. Required during creation. Include global_level when changing it.
updated_atstringRequired within parentRecord update date

Referenced models: Update a level — response body — parent, Update a level — response body — track

Retrieve a specific worker — response body — manager

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

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

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

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

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

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

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

Retrieve a specific worker — response body — user

FieldTypePresenceDescription and constraints
$objectRootThe worker's associated user.

Expandable field
activebooleanOptionalWhether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.
addressesarrayOptionalThe user's addresses.
addresses[]ModelEach itemExpand Retrieve a specific user — response body — addresses item
created_atstringRequired within parentRecord creation date
display_namestringOptionalThe display name of the user using either the concatenated preferred given and family name or username depending on availability.
emailsarrayOptionalThe user's email addresses.
emails[]ModelEach itemExpand Retrieve a specific user — response body — emails item
idstringRequired within parentIdentifier field
localestringOptionalThe User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.
nameModelOptionalExpand Retrieve a specific user — response body — name
numberstringOptionalThe permanent profile number of the user.
phone_numbersarrayOptionalThe user's phone numbers.
phone_numbers[]ModelEach itemExpand Retrieve a specific user — response body — phone numbers item
photosarrayOptionalThe user's photos.
photos[]ModelEach itemExpand Retrieve a specific user — response body — photos item
preferred_languagestringOptionalThe 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.
timezonestringOptionalThe User's current time zone in IANA database Olson format
updated_atstringRequired within parentRecord update date
usernamestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootThe scheduled working hours for a day of the week.
hoursJSONOptional
hours (anyOf 1)numberAlternativeThe number of scheduled working hours for the day.
hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve an agent deployment — response body — diagnostics item

FieldTypePresenceDescription and constraints
$objectRoot
messagestringOptionalThe diagnostic message
pathstringOptionalThe source path for the diagnostic
severitystringOptionalThe diagnostic severity

Retrieve list view capabilities for a custom object — response body

FieldTypePresenceDescription and constraints
$objectRootPermissions to create saved views and choose a company default for a Custom Object.
can_create_privatebooleanRequired within parentWhether the caller may create private views.
can_create_sharedbooleanRequired within parentWhether the caller may create shared views.
can_set_defaultbooleanRequired within parentWhether the caller may change the company default.

Retrieve my SSO information — response body — company legal entities item

FieldTypePresenceDescription and constraints
$objectRoot
companyModelOptionalExpand List companies — response body — results item
The company or organization associated with the legal entity

Expandable field
company_idstringOptionalThe company or organization associated with the legal entity
countryModelOptionalExpand Retrieve a specific legal entity — response body — country
created_atstringRequired within parentRecord creation date
entity_levelstringOptionalThe 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
idstringRequired within parentIdentifier field
legal_namestringOptionalThe legal name of the legal entity.
mailing_addressModelOptionalExpand Retrieve a specific legal entity — response body — mailing address
management_typestringOptionalThe 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
parentModelOptionalExpand Retrieve a specific legal entity — response body — parent
The parent legal entity.

Expandable field
parent_idstringOptionalThe parent legal entity.
physical_addressModelOptionalExpand Retrieve a specific legal entity — response body — physical address
registration_datestringOptionalThe registration date of the entity.
tax_identifierstringOptionalThe tax identifier for the legal entity.
updated_atstringRequired within parentRecord 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

FieldTypePresenceDescription and constraints
$objectRootThe company's ultimate holding entity.

Expandable field
companyModelOptionalExpand List companies — response body — results item
The company or organization associated with the legal entity

Expandable field
company_idstringOptionalThe company or organization associated with the legal entity
countryModelOptionalExpand Retrieve a specific legal entity — response body — country
created_atstringRequired within parentRecord creation date
entity_levelstringOptionalThe 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
idstringRequired within parentIdentifier field
legal_namestringOptionalThe legal name of the legal entity.
mailing_addressModelOptionalExpand Retrieve a specific legal entity — response body — mailing address
management_typestringOptionalThe 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
parentModelOptionalExpand Retrieve a specific legal entity — response body — parent
The parent legal entity.

Expandable field
parent_idstringOptionalThe parent legal entity.
physical_addressModelOptionalExpand Retrieve a specific legal entity — response body — physical address
registration_datestringOptionalThe registration date of the entity.
tax_identifierstringOptionalThe tax identifier for the legal entity.
updated_atstringRequired within parentRecord 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

FieldTypePresenceDescription and constraints
$objectRootThe physical address of the holding entity.
countrystringOptionalThe 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
formattedstringOptionalThe formatted mailing address.
localitystringOptionalThe city or locality component.
postal_codestringOptionalThe zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
regionstringOptionalThe state or region component, pursuant to SCIM RFC 7643 4.1.2.
street_addressstringOptionalThe 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..
typestringOptionalThe classification of the address.
Known values: HOME, WORK, OTHER

Retrieve record details — response body

FieldTypePresenceDescription and constraints
$objectRootRecord values, edit capabilities, and the effective page layout for one readable Custom Object record.
capabilitiesModelRequired within parentExpand Retrieve record details — response body — capabilities
fieldsobjectRequired within parentPermission-visible direct fields plus read-only related fields used by the layout.
Additional keys: see wildcard field
fields.*JSONAdditional keys
fields.* (anyOf 1)ModelAlternativeExpand Retrieve record details — response body — fields / value / data_type: TEXT, LONG TEXT, EMAIL, URL, PHONE NUMBER, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
fields.* (anyOf 2)ModelAlternativeExpand Retrieve record details — response body — fields / value / data_type: NUMBER, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
fields.* (anyOf 3)ModelAlternativeExpand Retrieve record details — response body — fields / value / data_type: BOOLEAN, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
fields.* (anyOf 4)ModelAlternativeExpand Retrieve record details — response body — fields / value / data_type: DATE, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
fields.* (anyOf 5)ModelAlternativeExpand Retrieve record details — response body — fields / value / data_type: DATETIME, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
fields.* (anyOf 6)ModelAlternativeExpand Retrieve record details — response body — fields / value / data_type: CURRENCY, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
fields.* (anyOf 7)ModelAlternativeExpand Retrieve record details — response body — fields / value / data_type: RADIO, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
fields.* (anyOf 8)ModelAlternativeExpand Retrieve record details — response body — fields / value / data_type: SELECT, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
fields.* (anyOf 9)ModelAlternativeExpand Retrieve record details — response body — fields / value / data_type: OG REFERENCE FIELD, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED
fields.* (anyOf 10)ModelAlternativeExpand Retrieve record details — response body — fields / value / value_state: PRESENT, EMPTY, MASKED, UNSUPPORTED
idstringRequired within parentStable record identifier returned by the canonical Custom Object record list or query endpoint. Use it with object_api_name for canonical record GET and PATCH.
layoutModelRequired within parentExpand Retrieve record details — response body — layout
object_api_namestringRequired within parentCustom Object API name, such as equipment__c, used to address this record's collection. Obtain it from the Custom Object definition or grid configuration.
updated_atstringRequired within parentISO 8601 UTC timestamp of the loaded record version. Pass this exact value as lock_update_time in the canonical record PATCH to detect stale writes.
Format: date-time

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

FieldTypePresenceDescription and constraints
$objectRootPermissions and lock state for this caller.
editablebooleanRequired within parentWhether at least one field can be edited by this caller.
lockedbooleanRequired within parentWhether the record is locked against changes.

Retrieve record details — response body — fields / value / data_type: BOOLEAN, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED

FieldTypePresenceDescription and constraints
$objectRootA readable record field and the caller's ability to edit it.
api_namestringRequired within parentField 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_typestringRequired within parentBOOLEAN contains true or false.
Known values: BOOLEAN
editablebooleanRequired within parentWhether this caller can edit this field on this record.
labelstringRequired within parentField display name.
multiplebooleanRequired within parentWhether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.
optionsarrayRequired within parentConfigured choice values; empty for non-choice fields.
options[]stringEach item
read_only_reasonJSONOptional
read_only_reason (anyOf 1)stringAlternativePERMISSION_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)nullAlternative
reference_objectJSONOptional
reference_object (anyOf 1)stringAlternativeTarget 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)nullAlternative
requiredbooleanRequired within parentWhether a nonempty value is required by the field schema.
valueJSONRequired within parent
value (anyOf 1)booleanAlternativeWhether the configured condition is true; null unless value_state is PRESENT.
value (anyOf 2)nullAlternative
value_statestringRequired within parentPRESENT 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

FieldTypePresenceDescription and constraints
$objectRootA readable record field and the caller's ability to edit it.
api_namestringRequired within parentField 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_typestringRequired within parentCURRENCY contains a monetary amount and its currency.
Known values: CURRENCY
editablebooleanRequired within parentWhether this caller can edit this field on this record.
labelstringRequired within parentField display name.
multiplebooleanRequired within parentWhether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.
optionsarrayRequired within parentConfigured choice values; empty for non-choice fields.
options[]stringEach item
read_only_reasonJSONOptional
read_only_reason (anyOf 1)stringAlternativePERMISSION_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)nullAlternative
reference_objectJSONOptional
reference_object (anyOf 1)stringAlternativeTarget 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)nullAlternative
requiredbooleanRequired within parentWhether a nonempty value is required by the field schema.
valueJSONRequired within parentPlatform 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)ModelAlternativeExpand Retrieve record details — response body — fields / value / data_type: CURRENCY, value state: PRESENT, EMPTY, MASKED, UNSUPPORTED value currency type, value
value (anyOf 2)JSONAlternative
value (anyOf 2) (anyOf 1)stringAlternative
value (anyOf 2) (anyOf 2)nullAlternative
value_statestringRequired within parentPRESENT 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

FieldTypePresenceDescription and constraints
$objectRootPlatform Currency serialized with a decimal string amount to preserve precision.
currency_typestringRequired within parentISO 4217 currency code, for example USD or EUR.
Pattern: ^[A-Z]{3}$
valuestringRequired within parentDecimal 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

FieldTypePresenceDescription and constraints
$objectRootA readable record field and the caller's ability to edit it.
api_namestringRequired within parentField 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_typestringRequired within parentDATE contains a calendar date without a time or timezone.
Known values: DATE
editablebooleanRequired within parentWhether this caller can edit this field on this record.
labelstringRequired within parentField display name.
multiplebooleanRequired within parentWhether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.
optionsarrayRequired within parentConfigured choice values; empty for non-choice fields.
options[]stringEach item
read_only_reasonJSONOptional
read_only_reason (anyOf 1)stringAlternativePERMISSION_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)nullAlternative
reference_objectJSONOptional
reference_object (anyOf 1)stringAlternativeTarget 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)nullAlternative
requiredbooleanRequired within parentWhether a nonempty value is required by the field schema.
valueJSONRequired within parent
value (anyOf 1)stringAlternativeCalendar date in YYYY-MM-DD format, for example 2026-10-24; null unless value_state is PRESENT.
Format: date
value (anyOf 2)nullAlternative
value_statestringRequired within parentPRESENT 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

FieldTypePresenceDescription and constraints
$objectRootA readable record field and the caller's ability to edit it.
api_namestringRequired within parentField 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_typestringRequired within parentDATETIME contains an instant and is read-only in this release.
Known values: DATETIME
editablebooleanRequired within parentWhether this caller can edit this field on this record.
labelstringRequired within parentField display name.
multiplebooleanRequired within parentWhether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.
optionsarrayRequired within parentConfigured choice values; empty for non-choice fields.
options[]stringEach item
read_only_reasonJSONOptional
read_only_reason (anyOf 1)stringAlternativePERMISSION_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)nullAlternative
reference_objectJSONOptional
reference_object (anyOf 1)stringAlternativeTarget 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)nullAlternative
requiredbooleanRequired within parentWhether a nonempty value is required by the field schema.
valueJSONRequired within parent
value (anyOf 1)stringAlternativeISO 8601 timestamp with timezone, normalized to UTC; null unless value_state is PRESENT.
Format: date-time
value (anyOf 2)nullAlternative
value_statestringRequired within parentPRESENT 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

FieldTypePresenceDescription and constraints
$objectRootA readable record field and the caller's ability to edit it.
api_namestringRequired within parentField 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_typestringRequired within parentNUMBER contains a decimal quantity.
Known values: NUMBER
editablebooleanRequired within parentWhether this caller can edit this field on this record.
labelstringRequired within parentField display name.
multiplebooleanRequired within parentWhether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.
optionsarrayRequired within parentConfigured choice values; empty for non-choice fields.
options[]stringEach item
read_only_reasonJSONOptional
read_only_reason (anyOf 1)stringAlternativePERMISSION_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)nullAlternative
reference_objectJSONOptional
reference_object (anyOf 1)stringAlternativeTarget 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)nullAlternative
requiredbooleanRequired within parentWhether a nonempty value is required by the field schema.
valueJSONRequired within parent
value (anyOf 1)stringAlternativeDecimal 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)nullAlternative
value_statestringRequired within parentPRESENT 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

FieldTypePresenceDescription and constraints
$objectRootA readable record field and the caller's ability to edit it.
api_namestringRequired within parentField 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_typestringRequired within parentOG_REFERENCE_FIELD identifies a reference to the collection in reference_object, including standard owner and audit Worker references.
Known values: OG_REFERENCE_FIELD
editablebooleanRequired within parentWhether this caller can edit this field on this record.
labelstringRequired within parentField display name.
multiplebooleanRequired within parentWhether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.
optionsarrayRequired within parentConfigured choice values; empty for non-choice fields.
options[]stringEach item
read_only_reasonJSONOptional
read_only_reason (anyOf 1)stringAlternativePERMISSION_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)nullAlternative
reference_objectJSONOptional
reference_object (anyOf 1)stringAlternativeTarget 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)nullAlternative
requiredbooleanRequired within parentWhether a nonempty value is required by the field schema.
valueJSONRequired within parentCanonical 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)ModelAlternativeExpand 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)ModelAlternativeExpand 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)JSONAlternative
value (anyOf 3) (anyOf 1)stringAlternative
value (anyOf 3) (anyOf 2)nullAlternative
value_statestringRequired within parentPRESENT 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

FieldTypePresenceDescription and constraints
$objectRootA canonical Custom Object record relationship, including its dynamic fields.
custom_object_recordJSONOptionalExact 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)ModelAlternativeExpand Retrieve a specific custom object record — response body
custom_object_record (anyOf 2)JSONAlternative
custom_object_record (anyOf 2) (anyOf 1)stringAlternative
custom_object_record (anyOf 2) (anyOf 2)nullAlternative
custom_object_record_idstringRequired within parentCanonical 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

FieldTypePresenceDescription and constraints
$objectRootA canonical Worker relationship; Worker facts belong to its expansion.
workerJSONOptionalExact 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)ModelAlternativeExpand Retrieve a specific worker — response body — manager
worker (anyOf 2)JSONAlternative
worker (anyOf 2) (anyOf 1)stringAlternative
worker (anyOf 2) (anyOf 2)nullAlternative
worker_idstringRequired within parentCanonical 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

FieldTypePresenceDescription and constraints
$objectRootA readable record field and the caller's ability to edit it.
api_namestringRequired within parentField 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_typestringRequired within parentRADIO contains one configured choice.
Known values: RADIO
editablebooleanRequired within parentWhether this caller can edit this field on this record.
labelstringRequired within parentField display name.
multiplebooleanRequired within parentWhether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.
optionsarrayRequired within parentConfigured choice values; empty for non-choice fields.
options[]stringEach item
read_only_reasonJSONOptional
read_only_reason (anyOf 1)stringAlternativePERMISSION_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)nullAlternative
reference_objectJSONOptional
reference_object (anyOf 1)stringAlternativeTarget 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)nullAlternative
requiredbooleanRequired within parentWhether a nonempty value is required by the field schema.
valueJSONRequired within parent
value (anyOf 1)stringAlternativeOne value from options; null unless value_state is PRESENT.
value (anyOf 2)nullAlternative
value_statestringRequired within parentPRESENT 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

FieldTypePresenceDescription and constraints
$objectRootA readable record field and the caller's ability to edit it.
api_namestringRequired within parentField 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_typestringRequired within parentSELECT contains zero or more configured choices.
Known values: SELECT
editablebooleanRequired within parentWhether this caller can edit this field on this record.
labelstringRequired within parentField display name.
multiplebooleanRequired within parentWhether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.
optionsarrayRequired within parentConfigured choice values; empty for non-choice fields.
options[]stringEach item
read_only_reasonJSONOptional
read_only_reason (anyOf 1)stringAlternativePERMISSION_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)nullAlternative
reference_objectJSONOptional
reference_object (anyOf 1)stringAlternativeTarget 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)nullAlternative
requiredbooleanRequired within parentWhether a nonempty value is required by the field schema.
valueJSONRequired within parent
value (anyOf 1)arrayAlternativeSelected values from options. An empty selection is []; null unless value_state is PRESENT.
value (anyOf 1)[]stringEach item
value (anyOf 2)nullAlternative
value_statestringRequired within parentPRESENT 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

FieldTypePresenceDescription and constraints
$objectRootA readable record field and the caller's ability to edit it.
api_namestringRequired within parentField 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_typestringRequired within parentTEXT and LONG_TEXT contain text; EMAIL, URL, and PHONE_NUMBER contain their respective textual values.
Known values: TEXT, LONG_TEXT, EMAIL, URL, PHONE_NUMBER
editablebooleanRequired within parentWhether this caller can edit this field on this record.
labelstringRequired within parentField display name.
multiplebooleanRequired within parentWhether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.
optionsarrayRequired within parentConfigured choice values; empty for non-choice fields.
options[]stringEach item
read_only_reasonJSONOptional
read_only_reason (anyOf 1)stringAlternativePERMISSION_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)nullAlternative
reference_objectJSONOptional
reference_object (anyOf 1)stringAlternativeTarget 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)nullAlternative
requiredbooleanRequired within parentWhether a nonempty value is required by the field schema.
valueJSONRequired within parent
value (anyOf 1)stringAlternativeReadable text, or null unless value_state is PRESENT.
value (anyOf 2)nullAlternative
value_statestringRequired within parentPRESENT 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

FieldTypePresenceDescription and constraints
$objectRootA readable record field and the caller's ability to edit it.
api_namestringRequired within parentField 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_typestringRequired within parentThese 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
editablebooleanRequired within parentWhether this caller can edit this field on this record.
labelstringRequired within parentField display name.
multiplebooleanRequired within parentWhether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.
optionsarrayRequired within parentConfigured choice values; empty for non-choice fields.
options[]stringEach item
read_only_reasonJSONOptional
read_only_reason (anyOf 1)stringAlternativePERMISSION_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)nullAlternative
reference_objectJSONOptional
reference_object (anyOf 1)stringAlternativeTarget 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)nullAlternative
requiredbooleanRequired within parentWhether a nonempty value is required by the field schema.
valueJSONRequired within parent
value (anyOf 1)stringAlternativeAlways null because this field type is unsupported.
value (anyOf 2)nullAlternative
value_statestringRequired within parentPRESENT 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

FieldTypePresenceDescription and constraints
$objectRootEffective saved page layout.
api_namestringRequired within parentResolved saved layout API name.
headerModelRequired within parentExpand Retrieve record details — response body — layout header
revisionstringRequired within parentOpaque revision of the effective, permission-filtered layout. Compare to detect layout changes; this is not the record write version.
tabsarrayRequired within parentOrdered, visible tabs.
tabs[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootSemantic record header.
description_fieldJSONOptional
description_field (anyOf 1)stringAlternativeDescription field API name, or null when unavailable.
description_field (anyOf 2)nullAlternative
fieldsarrayRequired within parentOrdered summary field API names.
fields[]stringEach item
title_fieldJSONOptional
title_field (anyOf 1)stringAlternativeTitle field API name, or null when unavailable.
title_field (anyOf 2)nullAlternative

Retrieve record details — response body — layout tabs item

FieldTypePresenceDescription and constraints
$objectRootOrdered, visible tab of sections in the effective record page layout.
idstringRequired within parentStable tab identifier.
labelstringRequired within parentTab display name.
sectionsarrayRequired within parentOrdered, visible sections.
sections[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootVisible group of field placements, a deferred related list, or explicitly unsupported content.
columnsJSONRequired within parent
columns (anyOf 1)integerAlternativeSuggested field columns; clients may adapt to available space.
columns (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fieldsarrayRequired within parentOrdered placements for a FIELDS section. Empty for RELATED_LIST and UNSUPPORTED sections.
fields[]ModelEach itemExpand Retrieve record details — response body — layout tabs item sections item fields item
idstringRequired within parentSection identifier scoped to the effective layout. Use a RELATED_LIST section's records_link to retrieve its records.
labelstringRequired within parentSection display name.
object_api_nameJSONOptional
object_api_name (anyOf 1)stringAlternativeRelated Custom Object API name; null for other sections.
object_api_name (anyOf 2)nullAlternative
reasonJSONOptional
reason (anyOf 1)stringAlternativeCONTENT_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)nullAlternative
records_linkJSONOptional
records_link (anyOf 1)stringAlternativeAuthorized related-record collection URL, including the resolved layout; null for other sections.
records_link (anyOf 2)nullAlternative
typestringRequired within parentFIELDS 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

FieldTypePresenceDescription and constraints
$objectRootPlacement of a readable field in a saved layout; contains no field value.
fieldstringRequired within parentField API name in the response fields map.
read_onlybooleanRequired within parentWhether this placement is read-only.

Set or clear the company's default list view — response body

FieldTypePresenceDescription and constraints
$objectRootThe shared saved view to use as a Custom Object's company default, or null to clear it.
Additional keys: not allowed
view_api_nameJSONRequired within parent
view_api_name (anyOf 1)stringAlternativeShared view API name; null clears the company default.
view_api_name (anyOf 2)nullAlternative

Trigger a report run — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
filtersJSONOptional
filters (anyOf 1)arrayAlternativeOptional list of filters to apply when running the report
Default: null
filters (anyOf 1)[]ModelEach itemExpand Trigger a report run — request body — body filters array item
filters (anyOf 2)nullAlternative
format_currency_fieldsJSONOptional
format_currency_fields (anyOf 1)JSONAlternativeFormatting options for currency fields
Default: null
format_currency_fields (anyOf 1) (anyOf 1)objectAlternative
format_currency_fields (anyOf 1) (anyOf 1).columnsstringRequired within parentCurrency column format for currency fields
One of: TYPE_AND_AMOUNT, VALUE_ONLY
format_currency_fields (anyOf 1) (anyOf 1).currency_typeJSONOptional
format_currency_fields (anyOf 1) (anyOf 1).currency_type (anyOf 1)stringAlternativeCurrency type (e.g., 'USD')
format_currency_fields (anyOf 1) (anyOf 1).currency_type (anyOf 2)nullAlternative
format_currency_fields (anyOf 1) (anyOf 2)nullAlternative
format_currency_fields (anyOf 2)nullAlternative
format_date_fieldsJSONOptional
format_date_fields (anyOf 1)JSONAlternativeFormatting options for date fields
Default: null
format_date_fields (anyOf 1) (anyOf 1)objectAlternative
format_date_fields (anyOf 1) (anyOf 1).date_formatstringRequired within parentDate format for date fields in the report output
One of: ISO_8601, APPLY_VISUALIZATION_SETTINGS
format_date_fields (anyOf 1) (anyOf 1).datetime_timezoneJSONOptional
format_date_fields (anyOf 1) (anyOf 1).datetime_timezone (anyOf 1)stringAlternativeTimezone for datetime fields (e.g., 'America/Los_Angeles')
format_date_fields (anyOf 1) (anyOf 1).datetime_timezone (anyOf 2)nullAlternative
format_date_fields (anyOf 1) (anyOf 2)nullAlternative
format_date_fields (anyOf 2)nullAlternative
include_object_idsbooleanOptionalWhether to include object IDs in the report output
Default: false
include_total_rowsbooleanOptionalWhether to include total row count in the report output
Default: false
output_typestringOptionalOutput format for the report data
Default: JSON
One of: JSON, CSV
report_idstringRequired within parentThe ID of the report to run
view_asstringOptionalControls 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

FieldTypePresenceDescription and constraints
$objectRootA single filter to apply when running a report. The expected shape of 'value' depends on the operator — see the FilterOperator description for details.
field_idstringRequired within parentThe ID of the report field to filter on
operatorstringRequired within parentComparison 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
valueJSONOptional
value (anyOf 1)JSONAlternativeThe 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)stringAlternative
value (anyOf 1) (oneOf 2)numberAlternative
value (anyOf 1) (oneOf 3)booleanAlternative
value (anyOf 1) (oneOf 4)arrayAlternative
value (anyOf 1) (oneOf 5)ModelAlternativeExpand Trigger a report run — request body — body filters array item value value from, to
value (anyOf 1) (oneOf 6)ModelAlternativeExpand Trigger a report run — request body — body filters array item value value n, unit
value (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootRange bounds for 'between' and 'not_between' operators

Trigger a report run — request body — body filters array item value value n, unit

FieldTypePresenceDescription and constraints
$objectRootRolling date window for 'last_n' and 'next_n' operators

Update a Custom App — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
api_namestringRequired within parentThe unique api name of the custom app
descriptionstringOptionalThe description of the custom app
namestringRequired within parentThe display name of the custom app

Update a Custom App — response body — pages item

FieldTypePresenceDescription and constraints
$objectRootSummary of a page attached to a custom app.
api_namestringOptionalThe unique name of the page within the app
canvas_instance_idstringOptionalThe ID of the canvas instance backing this page (canvas_page only)
created_bystringOptionalThe ID of the role that created the page
function_idstringOptionalThe ID of the Rippling Function rendering this page (sdui_page only)
page_typestringOptionalThe type of page (e.g. 'canvas_page', 'sdui_page', 'object_page')
sdui_page_idstringOptionalThe ID of the SDUI page instance (sdui_page only)
updated_bystringOptionalThe ID of the role that last modified the page

Update a Custom Page — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
function_idstringOptionalThe ID of the Rippling Function that renders this page
namestringOptionalThe display name of the custom page

Update a Setting — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
api_namestringOptionalThe unique api name of the setting
boolean_valuebooleanOptionalBoolean value of the setting, if it has boolean data type
data_typestringOptionalData type of the setting
display_namestringOptionalThe display name of setting
number_valuenumberOptionalNumber value of the setting, if it has number data type
secret_valuestringOptionalSecret value of the setting, if it has secret data type
string_valuestringOptionalString value of the setting, if it has string data type
valueJSONOptional
value (anyOf 1)stringAlternative
value (anyOf 2)numberAlternative
value (anyOf 3)booleanAlternative

Update a background check candidate — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
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.
emailstringRequired within parentThe email address of the candidate. Required on create, but may be null on read for legacy rows.
external_idstringRequired within parentThe 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_namestringOptionalThe first name of the candidate.
last_namestringOptionalThe last name of the candidate.
middle_namestringOptionalThe middle name of the candidate.

Update a custom object list view — request body — body

FieldTypePresenceDescription and constraints
$objectRootChanges to a saved grid definition; omitted properties retain their saved values.
Minimum fields: 1
Additional keys: not allowed
columnsarrayOptionalOrdered, nonempty, unique field selection.
columns[]ModelEach itemExpand Create a custom object list view — request body — body columns item
descriptionJSONOptional
description (anyOf 1)stringAlternativeCreator-provided explanation of the records or purpose of this saved view. Null clears the explanation; omission preserves it.
description (anyOf 2)nullAlternative
namestringOptionalNonblank display name.
order_byJSONOptional
order_by (anyOf 1)stringAlternativeOne sortable field API name, a space, and lowercase asc or desc, for example name asc. Null clears saved ordering.
order_by (anyOf 2)nullAlternative
queryJSONOptional
query (anyOf 1)stringAlternativeSaved RQL predicate; null clears it.
query (anyOf 2)nullAlternative
record_scopestringOptionalALL includes all records the caller may read; MY_RECORDS restricts owners to the authenticated requester when the view is used. Omission preserves the saved scope.
One of: ALL, MY_RECORDS
visibilitystringOptionalPRIVATE 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: see wildcard field
$.*JSONAdditional keys

Update a department — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe name of the department.
parent_idstringOptionalThe parent department.
reference_codestringOptionalReference code of the department.

Update a department — response body — parent

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
department_hierarchyarrayOptionalList of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.

Expandable field
department_hierarchy[]ModelEach itemExpand Update a department — response body — parent
department_hierarchy_idarrayOptionalThe identifier of departments in the department hierarchy ordered from parent department to child department.
department_hierarchy_id[]stringEach item
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the department.
parentModelOptionalExpand Update a department — response body — parent
The parent department.

Expandable field
parent_idstringOptionalThe parent department.
reference_codestringOptionalReference code of the department.
updated_atstringRequired within parentRecord update date

Referenced models: Update a department — response body — parent

Update a function — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
code_draftstringOptionalThe current draft of code for the function
dependenciesobjectOptionalThe dependencies of the function
descriptionstringOptionalThe function description
listed_in_custom_appsbooleanOptionalWhether this request-function is listed in the Custom Apps grid and navigation. Defaults to false on creation; omitted updates preserve the current value. Listing does not grant access or change deployment behavior. Only supported for request functions. Setting this field on an event function returns a validation error.
namestringOptionalThe function name
source_uploadobjectOptionalOptional source ZIP checksum and size for request functions only. Create or update returns ephemeral source_upload_instructions; this input is not returned.
source_upload.sha256stringRequired within parentSHA-256 of the exact ZIP bytes, written as 64 lowercase hexadecimal characters.
source_upload.size_bytesintegerRequired within parentExact ZIP size in bytes, from 1 through 67108864 (64 MiB).

Update a function — response body — source upload instructions

FieldTypePresenceDescription and constraints
$objectRootUpload instructions returned only when source_upload was requested on create or update.
archiveModelRequired within parentExpand Update a function — response body — source upload instructions archive
expires_atstringRequired within parentUTC expiration of the upload instructions, in RFC3339/ISO8601 format.
fieldsobjectRequired within parentInclude every opaque signed field unchanged in the multipart/form-data POST, plus the ZIP file.
Additional keys: see wildcard field
fields.*stringAdditional keys
methodstringRequired within parentHTTP method for the client-direct upload.
Known values: POST
urlstringRequired within parentUpload 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

FieldTypePresenceDescription and constraints
$objectRootArchive reference for a subsequent deployment after the upload succeeds.
object_keystringRequired within parentTenant-scoped object key to use as the archive reference in the explicit deployment JSON.
sha256stringRequired within parentSHA-256 of the ZIP bytes.
size_bytesJSONRequired within parent
size_bytes (anyOf 1)integerAlternativeExact ZIP size in bytes, returned as a JSON integer.
size_bytes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a job assignment — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
change_reasonstringOptionalReason recorded on the change (e.g., the reason for scheduling an unassignment).
effective_fromstringOptionalDate and time the change becomes effective (ISO 8601 format, e.g., 2025-11-07T17:00:00.000+00:00); defaults to current time in UTC if not provided. job_pay_rate_effective_from is ignored if this field is provided.
job_code_idstringOptionalIdentifier of job that is assigned to worker
job_pay_ratenumberOptionalThe pay rate for job assigned to worker. This can be different from the job's standard pay rate and can be overriden for a worker.
job_pay_rate_change_reasonstringOptionalThis field is deprecated and will be removed in a future version, use the new change_reason field instead.
job_pay_rate_effective_fromstringOptionalThis field is deprecated and will be removed in a future version, use the new effective_from field instead.
worker_idstringOptionalIdentifier of worker to whom job is assigned.

Update a job assignment — response body — job code

FieldTypePresenceDescription and constraints
$objectRootJob that is assigned to worker

Expandable field
created_atstringRequired within parentRecord creation date
custom_locationModelOptionalExpand Update a job code — response body — custom location
departmentModelOptionalExpand Update a job code — response body — department
department_idstringOptionalThe department associated with the job code.
external_idstringOptionalThe unique identifier of the job code in an outside system.
group_idstringOptionalThe ID of the job roster group.
idstringRequired within parentIdentifier field
is_archivedbooleanOptionalWhether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.
job_dimensionModelOptionalExpand Update a job code — response body — job dimension
job_dimension_idstringRequired within parentThe ID of the job dimension this job code belongs to.
namestringRequired within parentThe name of the job dimension.
pay_rateJSONOptional
pay_rate (anyOf 1)numberAlternativeThe pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.
pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pay_rate_exceptionsarrayOptionalPay rate overrides for the job based on exception dimension values.

Expandable field
pay_rate_exceptions[]ModelEach itemExpand Update a job code — response body — pay rate exceptions item
pay_rate_exceptions_idarrayOptionalPay rate overrides id for the job based on exception dimension values.
pay_rate_exceptions_id[]stringEach item
updated_atstringRequired within parentRecord update date
work_locationModelOptionalExpand Update a job code — response body — work location
work_location_idstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootWorker to whom job is assigned.

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

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

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

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

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

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

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

Update a job code — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
custom_locationModelOptionalExpand Update a job code — request body — body custom location
external_idstringOptionalThe unique identifier of the job code in an outside system.
is_archivedbooleanOptionalWhether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.
job_dimension_idstringOptionalThe ID of the job dimension this job code belongs to.
namestringOptionalThe name of the job dimension.
pay_ratenumberOptionalThe pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.
pay_rate_change_reasonstringOptionalReason for setting, updating, or resetting the pay rate on this job code.
pay_rate_effective_fromstringOptionalDate and time the pay rate becomes effective (ISO 8601 format YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to current time in UTC if not provided.

Referenced models: Update a job code — request body — body custom location

Update a job code — request body — body custom location

FieldTypePresenceDescription and constraints
$objectRootThe 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.
addressModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe address of the custom location.
countrystringOptionalThe 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
localitystringOptionalThe city or locality component.
postal_codestringOptionalThe zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
regionstringOptionalThe state or region component, pursuant to SCIM RFC 7643 4.1.2.
street_addressstringOptionalThe 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..
typestringOptionalThe classification of the address.
One of: HOME, WORK, OTHER

Update a job code — response body — custom location

FieldTypePresenceDescription and constraints
$objectRootThe 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.
addressModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe address of the custom location.
countrystringOptionalThe 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
formattedstringOptionalThe formatted mailing address.
localitystringOptionalThe city or locality component.
postal_codestringOptionalThe zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
regionstringOptionalThe state or region component, pursuant to SCIM RFC 7643 4.1.2.
street_addressstringOptionalThe 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..
typestringOptionalThe classification of the address.
Known values: HOME, WORK, OTHER

Update a job code — response body — department

FieldTypePresenceDescription and constraints
$objectRootThe department associated with the job code.

Expandable field
created_atstringRequired within parentRecord creation date
department_hierarchyarrayOptionalList of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.

Expandable field
department_hierarchy[]ModelEach itemExpand Update a department — response body — parent
department_hierarchy_idarrayOptionalThe identifier of departments in the department hierarchy ordered from parent department to child department.
department_hierarchy_id[]stringEach item
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the department.
parentModelOptionalExpand Update a department — response body — parent
The parent department.

Expandable field
parent_idstringOptionalThe parent department.
reference_codestringOptionalReference code of the department.
updated_atstringRequired within parentRecord update date

Referenced models: Update a department — response body — parent

Update a job code — response body — job dimension

FieldTypePresenceDescription and constraints
$objectRootThe job dimension this job code belongs to.

Expandable field
created_atstringRequired within parentRecord creation date
external_idstringOptionalThe unique identifier of the job dimension in a third party system
group_idstringOptionalThe ID of the dimension roster group.
idstringRequired within parentIdentifier field
includes_custom_locationbooleanOptionalWhether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.
namestringRequired within parentThe name of the job dimension
org_attribute_associationsarrayOptionalOrganizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.
org_attribute_associations[]JSONEach itemKnown values: DEPARTMENT, WORK_LOCATION, PAY_RATE, ENTITY
roster_typestringOptionalThe roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.
Known values: PER_DIMENSION, PER_JOB_CODE
updated_atstringRequired within parentRecord update date

Update a job code — response body — pay rate exceptions item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
exception_dimension_idstringRequired within parentIdentifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource
exception_dimension_typestringOptionalType of dimension on which exception is configured
Known values: JOB_CODE, LEVEL, TEAM, DEPARTMENT, WORK_LOCATION
idstringRequired within parentIdentifier field
job_codeModelOptionalExpand List job codes — response body — results item
Job for which exception is configured.

Expandable field
job_code_idstringRequired within parentIdentifier of Job for which exception is configured.
pay_rateJSONRequired within parent
pay_rate (anyOf 1)numberAlternativeThe pay rate for exception on job_code_id and exception_dimension_id combination
pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentRecord update date

Referenced models: List job codes — response body — results item

Update a job code — response body — work location

FieldTypePresenceDescription and constraints
$objectRootThe work location associated with the job code.

Expandable field
addressModelRequired within parentExpand Update a work location — response body — address
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
namestringRequired within parentThe name of the work location.
updated_atstringRequired within parentRecord update date

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

Update a job dimension — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
external_idstringOptionalThe unique identifier of the job dimension in a third party system
includes_custom_locationbooleanOptionalWhether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.
namestringOptionalThe name of the job dimension
org_attribute_associationsarrayOptionalOrganizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.
org_attribute_associations[]JSONEach itemOne of: DEPARTMENT, WORK_LOCATION, PAY_RATE, ENTITY
roster_typestringOptionalThe roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.
One of: PER_DIMENSION, PER_JOB_CODE

Update a kiosk badge — request body — body

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

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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