Rippling: Rest API schemas (part 4)
65 Rippling schemas with complete fields and constraints.
← Rest API operations · All schemas
List job assignments — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
base_pay_rate | JSON | Optional | |
base_pay_rate (anyOf 1) | number | Alternative | Base compensation rate of worker |
base_pay_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
job_code | Model | Optional | Expand Update a job assignment — response body — job code |
job_code_id | string | Required within parent | Identifier of job that is assigned to worker |
job_pay_rate | JSON | Optional | |
job_pay_rate (anyOf 1) | number | Alternative | The pay rate for job assigned to worker. This can be different from the job's standard pay rate and can be overriden for a worker. |
job_pay_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
job_pay_rate_exceptions | array | Optional | Pay rate exceptions applicable for the worker based on certain exception dimension values. Expandable field |
job_pay_rate_exceptions[] | Model | Each item | Expand List job pay rate exceptions — response body — results item |
job_pay_rate_exceptions_id | array | Optional | Identifier of pay rate exceptions applicable for the worker based on certain exception dimension values. |
job_pay_rate_exceptions_id[] | string | Each item | |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Update a job assignment — response body — worker |
worker_id | string | Required within parent | Identifier of worker to whom job is assigned. |
Referenced models: List job pay rate exceptions — response body — results item, Update a job assignment — response body — job code, Update a job assignment — response body — worker
List job codes — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
custom_location | Model | Optional | Expand Update a job code — response body — custom location |
department | Model | Optional | Expand Update a job code — response body — department |
department_id | string | Optional | The department associated with the job code. |
external_id | string | Optional | The unique identifier of the job code in an outside system. |
group_id | string | Optional | The ID of the job roster group. |
id | string | Required within parent | Identifier field |
is_archived | boolean | Optional | Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API. |
job_dimension | Model | Optional | Expand Update a job code — response body — job dimension |
job_dimension_id | string | Required within parent | The ID of the job dimension this job code belongs to. |
name | string | Required within parent | The name of the job dimension. |
pay_rate | JSON | Optional | |
pay_rate (anyOf 1) | number | Alternative | The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute. |
pay_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pay_rate_exceptions | array | Optional | Pay rate overrides for the job based on exception dimension values. Expandable field |
pay_rate_exceptions[] | Model | Each item | Expand Update a job code — response body — pay rate exceptions item |
pay_rate_exceptions_id | array | Optional | Pay rate overrides id for the job based on exception dimension values. |
pay_rate_exceptions_id[] | string | Each item | |
updated_at | string | Required within parent | Record update date |
work_location | Model | Optional | Expand Update a job code — response body — work location |
work_location_id | string | Optional | The work location associated with the job code. |
Referenced models: Update a job code — response body — pay rate exceptions item, Update a job code — response body — custom location, Update a job code — response body — department, Update a job code — response body — job dimension, Update a job code — response body — work location
List job dimensions — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
external_id | string | Optional | The unique identifier of the job dimension in a third party system |
group_id | string | Optional | The ID of the dimension roster group. |
id | string | Required within parent | Identifier field |
includes_custom_location | boolean | Optional | Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true. |
name | string | Required within parent | The name of the job dimension |
org_attribute_associations | array | Optional | Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests. |
org_attribute_associations[] | JSON | Each item | Known values: DEPARTMENT, WORK_LOCATION, PAY_RATE, ENTITY |
roster_type | string | Optional | The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group. Known values: PER_DIMENSION, PER_JOB_CODE |
updated_at | string | Required within parent | Record update date |
List job functions — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
name | string | Optional | Displayed name of the job function |
updated_at | string | Required within parent | Record update date |
List job pay rate exceptions — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
exception_dimension_id | string | Required within parent | Identifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource |
exception_dimension_type | string | Optional | Type of dimension on which exception is configured Known values: JOB_CODE, LEVEL, TEAM, DEPARTMENT, WORK_LOCATION |
id | string | Required within parent | Identifier field |
job_code | Model | Optional | Expand Retrieve a specific job pay rate exception — response body — job code |
job_code_id | string | Required within parent | Identifier of Job for which exception is configured. |
pay_rate | JSON | Required within parent | |
pay_rate (anyOf 1) | number | Alternative | The pay rate for exception on job_code_id and exception_dimension_id combination |
pay_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Record update date |
Referenced models: Retrieve a specific job pay rate exception — response body — job code
List job requisitions — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
name | string | Required within parent | Job requisition name |
status | string | Required within parent | Job requisition status Known values: OPEN, CLOSED, PUBLISHED, DRAFT, ARCHIVED |
updated_at | string | Required within parent | Record update date |
List kiosk badges — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
badge_id | string | Required within parent | The ID associated with the badge. Not to be confused with the record's ID. |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_enabled | boolean | Optional | Whether this badge can be used with the Kiosk app. |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Update a kiosk badge — response body — worker |
worker_id | string | Optional | The ID of the worker associated with the badge. |
worker_number | JSON | Optional | |
worker_number (anyOf 1) | integer | Alternative | The employee number of the worker associated with the badge. |
worker_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Update a kiosk badge — response body — worker
List leave accruals — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Leave accrual resource representing time off credits granted to employees. Leave accruals track the allocation of paid time off (vacation, sick days, etc.) to employees based on company policies, manual grants, or other accrual sources. |
accrual_date | string | Required within parent | The date when this accrual becomes effective |
accrual_type | string | Optional | The type of accrual Known values: AUTO, CARRYOVER_PENALTY, RESET_PENALTY, RESET_NEGATIVE_PENALTY, BALANCE_PENALTY, LEAVE_GRANT, BALANCE_CORRECTION_ADJUSTMENT, PAID_OUT, SUB_BALANCE_EXPIRATION, TANDA_ACCRUAL_BONUS, TILT_ADJUSTMENT, WORKFLOW_ACTION, EXPIRATION_DEDUCTION, EXPIRATION_PAYOUT, MANUAL_BALANCE_PAYOUT, CARRYOVER_PENALTY_PAYOUT, RESET_PENALTY_PAYOUT, HOLIDAY_ADJUSTMENT, HOURS_WORKED_TANDA, TENURE_MILESTONE, FR_COP_FRACTIONNEMENT |
comment | string | Optional | The comment for this accrual. This is required if the leave policy requires a comment on accruals. |
created_at | string | Required within parent | Record creation date |
expiration_date | string | Optional | The date when this accrual expires (if applicable) |
grantor | Model | Optional | Expand Create a new leave accrual — response body — grantor |
grantor_id | string | Required within parent | The ID of the worker who granted this accrual. This is typically the Time Off admin. |
id | string | Required within parent | Identifier field |
leave_type_id | string | Required within parent | The company leave type ID associated with this accrual |
monetary_amount_accrued | JSON | Optional | |
monetary_amount_accrued (anyOf 1) | number | Alternative | The monetary value of this accrual (for policies with monetary tracking) |
monetary_amount_accrued (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
num_days | JSON | Optional | |
num_days (anyOf 1) | number | Alternative | The number of days accrued. It can be negative for deductions. This is applicable if the policy tracks in days. |
num_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
num_hours | JSON | Optional | |
num_hours (anyOf 1) | number | Alternative | The number of hours accrued. It can be negative for deductions. This is applicable if the policy tracks in hours. |
num_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Create a new leave accrual — response body — worker |
worker_id | string | Required within parent | The ID of the worker for whom the accrual is for |
Referenced models: Create a new leave accrual — response body — grantor, Create a new leave accrual — response body — worker
List leave balances — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
balance_excluding_future_requests | JSON | Optional | |
balance_excluding_future_requests (anyOf 1) | number | Alternative | The worker's leave balance excluding future leave requests. If the leave balance is unlimited, this field will be null. |
balance_excluding_future_requests (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance_excluding_future_requests_in_days | JSON | Optional | |
balance_excluding_future_requests_in_days (anyOf 1) | number | Alternative | The worker's leave balance in days excluding future leave requests. If the leave balance is unlimited, this field will be null. |
balance_excluding_future_requests_in_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance_including_future_requests | JSON | Optional | |
balance_including_future_requests (anyOf 1) | number | Alternative | The worker's leave balance including future leave requests. If the leave balance is unlimited, this field will be null. |
balance_including_future_requests (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance_including_future_requests_in_days | JSON | Optional | |
balance_including_future_requests_in_days (anyOf 1) | number | Alternative | The worker's leave balance in days including future leave requests. If the leave balance is unlimited, this field will be null. |
balance_including_future_requests_in_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_balance_unlimited | boolean | Optional | Indicates if the leave balance is unlimited. |
leave_type | Model | Optional | Expand Retrieve a specific leave balance — response body — leave type |
leave_type_id | string | Optional | The ID of the leave type associated with the leave balance. |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific leave balance — response body — worker |
worker_id | string | Required within parent | The ID of the worker associated with the leave balance. |
Referenced models: Retrieve a specific leave balance — response body — leave type, Retrieve a specific leave balance — response body — worker
List leave requests — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comments | string | Optional | The comments associated with the leave request. |
created_at | string | Required within parent | Record creation date |
days_take_off | array | Optional | The specific dates taken off and the amount of time taken off for each one. |
days_take_off[] | Model | Each item | Expand Update a leave request — response body — days take off item |
end_date | string | Required within parent | The end date of the leave request. |
end_time | string | Optional | The end time of the leave request. |
id | string | Required within parent | Identifier field |
is_managed_by_external_system | boolean | Optional | Whether the leave request is managed by an external system. |
leave_event_id | string | Optional | The ID of the leave event associated with the leave request, if any. |
leave_policy_id | string | Optional | The ID of the leave policy associated with the leave request, either leave_policy_id or leave_type_id must be provided. |
leave_type | Model | Optional | Expand Update a leave request — response body — leave type |
leave_type_id | string | Optional | The ID of the leave type associated with the leave request, either leave_policy_id or leave_type_id must be provided. |
number_of_minutes_requested | JSON | Optional | |
number_of_minutes_requested (anyOf 1) | number | Alternative | The number of minutes requested for the leave request. |
number_of_minutes_requested (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
reason_for_leave | string | Optional | The reason for the leave request. |
requester | Model | Optional | Expand Update a leave request — response body — requester |
requester_id | string | Optional | The ID of the worker who requested the leave request. |
reviewed_at | string | Optional | The timestamp of when the leave request was reviewed. |
reviewer | Model | Optional | Expand Update a leave request — response body — reviewer |
reviewer_id | string | Optional | The ID of the worker who reviewed the leave request. |
start_date | string | Required within parent | The start date of the leave request. |
start_time | string | Optional | The start time of the leave request. |
status | string | Required within parent | The status of the leave request. Known values: PENDING, APPROVED, REJECTED, CANCELED |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Update a leave request — response body — worker |
worker_id | string | Required within parent | The ID of the worker associated with the leave request. |
Referenced models: Update a leave request — response body — days take off item, Update a leave request — response body — leave type, Update a leave request — response body — requester, Update a leave request — response body — reviewer, Update a leave request — response body — worker
List leave types — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
description | string | Optional | The description of the leave type. |
id | string | Required within parent | Identifier field |
is_managed_by_external_system | boolean | Required within parent | Whether the leave is managed by an external system. |
is_paid | boolean | Required within parent | Whether the leave is paid. |
name | string | Required within parent | The name of the leave type. |
type | string | Required within parent | The type of leave. |
updated_at | string | Required within parent | Record update date |
List listing submission — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Creation timestamp. |
listing_id | string | Optional | The parent listing ID. |
notes | string | Optional | The latest submitted notes. |
status | string | Optional | The submission lifecycle status. |
submission_id | string | Optional | The submitted listing version ID. |
updated_at | string | Optional | Last update timestamp. |
List listing transition — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Optional | The lifecycle action recorded for this activity item. |
actor_id | string | Optional | The actor role ID that performed the action. |
comment | string | Optional | Optional comment recorded with the action. |
listing_id | string | Optional | The parent listing ID. |
new_status | string | Optional | The new lifecycle status. |
previous_status | string | Optional | The previous lifecycle status. |
submission_id | string | Optional | The listing version ID associated with this activity. |
timestamp | string | Optional | Activity timestamp. |
List location factors — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
adjustment_factor | JSON | Optional | |
adjustment_factor (anyOf 1) | number | Alternative | Compensation adjustment percentage |
adjustment_factor (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
country | Model | Optional | Expand Retrieve a specific location factor — response body — country |
created_at | string | Required within parent | Record creation date |
display_name | string | Optional | Human-readable name for the location factor |
id | string | Required within parent | Identifier field |
labour_bucket | string | Optional | The labor market category (e.g., "Engineering", "Marketing", "Sales") |
updated_at | string | Required within parent | Record update date |
Referenced models: Retrieve a specific location factor — response body — country
List object categories — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
description | string | Optional | The description of the Custom Category |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the Custom Category |
updated_at | string | Required within parent | Record update date |
List packages — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
description | string | Optional | The description of the package |
id | string | Required within parent | Identifier field |
latest_version_id | string | Optional | The ID of the latest package version, if any |
latest_version_number | string | Optional | The version number of the latest package version, if any |
package_display_name | string | Required within parent | The display name of the package |
package_key | string | Required within parent | The unique package key within the publisher company |
package_type | string | Required within parent | The package type Known values: MANAGED, UNMANAGED |
updated_at | string | Required within parent | Record update date |
List payroll-runs — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | V2 DTO representing a single payroll run. Used by: - GET /payroll-runs/ (list) - GET /payroll-runs/{id} (retrieve) |
approval_deadline | string | Optional | Deadline for approving the payroll run. |
approved_at | string | Optional | Timestamp when the run was approved. |
check_date | string | Optional | Date the paycheck is issued. |
company_entity_id | string | Optional | Identifier linking this payroll run to the company's legal entity in the HRIS system. |
country_code | string | Optional | ISO country code where the payroll run applies. |
debit_date | string | Optional | Date funds are debited from the company's account. |
id | string | Optional | Unique identifier for the payroll run. |
lock_deadline | string | Optional | Deadline after which the run is locked for changes. |
paid_at | string | Optional | Timestamp when the run was marked as paid. |
pay_period | object | Optional | Pay period details for this run. |
pay_period.end_date | string | Optional | End date of the pay period. |
pay_period.pay_frequency | string | Optional | Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY). |
pay_period.start_date | string | Optional | Start date of the pay period. |
payment_type | string | Optional | Payment method used (e.g. WIRE, ACH). |
run_state | string | Optional | Current state of the run (e.g. DRAFT, PAID, APPROVED). |
run_type | string | Optional | Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION). |
title | string | Optional | Human-readable title of the payroll run. |
List platform capabilities — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
version | string | Required within parent | Schema version |
List record detail reference options — response body — results item created at, id, updated at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root |
List record detail related records — response body — results item
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 — 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
List reimbursements — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Finance reimbursement the caller can see. A reimbursement is an expense the worker paid and the company pays back. Mileage and per diem use the same resource, with transaction_type MILEAGE_REIMBURSEMENT or PER_DIEM_REIMBURSEMENT. Retrieve returns one by ID. A reimbursement the caller cannot see returns 404, the same as one that does not exist. |
accounting_date | string | Optional | Date the transaction is booked in the accounting system, as an ISO 8601 date (YYYY-MM-DD). |
approval_status | string | Optional | Approval status of the transaction. `DRAFT`: not submitted for approval. `PENDING`: awaiting required information or submission before approval. `REQUESTED`: submitted and awaiting approval. `APPROVED`: approved. `REJECTED`: rejected. `FINALIZED`: finalized for payment. `ACTIONED`: payment or reimbursement completed. `CANCELLED`: cancelled. `FAILED`: payment failed. Null for card authorizations. Known values: DRAFT, PENDING, REQUESTED, APPROVED, REJECTED, FINALIZED, ACTIONED, CANCELLED, FAILED |
attachments | array | Optional | Other attached files, including filenames and recorded upload metadata. |
attachments[] | Model | Each item | Expand Retrieve a specific bill — response body — attachments item |
company_amount | object | Optional | Amount in the company's headquarters currency. The `value` is a decimal string. |
company_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
company_amount.value | JSON | Optional | |
company_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
company_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Record creation date |
distance | JSON | Optional | |
distance (anyOf 1) | number | Alternative | Trip length in mileage_rate.units. Null except on mileage reimbursements. |
distance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
end_location | Model | Optional | Expand Retrieve a specific reimbursement — response body — end location |
entity_id | string | Optional | ID of the legal entity the transaction belongs to. Use it with `/company-legal-entities/{id}/`. |
gl_sync_state | string | Optional | State of the sync to the accounting system. `NOT_FINALIZED`: not ready for accounting review. `FOR_REVIEW`: ready for accounting review. `PENDING_SYNC`: sync is in progress. `SYNCED`: synced to the accounting system. `ERROR`: sync failed. `DO_NOT_SYNC`: marked to be excluded from sync. `EXPORTED`: exported for accounting. `NOT_SYNCABLE`: this record cannot be synced. `AUTO_SYNC`: ready to be synced automatically. Null when no sync state is set. Known values: NOT_FINALIZED, FOR_REVIEW, PENDING_SYNC, SYNCED, ERROR, DO_NOT_SYNC, EXPORTED, NOT_SYNCABLE, AUTO_SYNC |
gl_vendor | object | Optional | Vendor in the connected accounting system. |
gl_vendor.gl_vendor_id | string | Optional | ID of the vendor in the accounting system. |
gl_vendor.id | string | Optional | ID of the accounting vendor in Rippling. |
gl_vendor.name | string | Optional | Name of the vendor in the accounting system. |
id | string | Required within parent | Identifier field |
line_items | array | Optional | Category splits of the transaction amount. |
line_items[] | Model | Each item | Expand Retrieve a specific bill — response body — line items item |
memo | string | Optional | Memo entered on the transaction. |
merchant_amount | object | Optional | Amount charged by the merchant, in the merchant currency. The `value` is a decimal string. |
merchant_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
merchant_amount.value | JSON | Optional | |
merchant_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
merchant_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
mileage_rate | Model | Optional | Expand Retrieve a specific reimbursement — response body — mileage rate |
mileage_rate_id | string | Optional | ID of the company mileage rate. Null except on mileage reimbursements. Resolve it with `expand=mileage_rate` on this reimbursement using `reimbursements.read`; there is no standalone rate lookup endpoint. |
payout_amount | object | Optional | Amount credited to the worker. The `value` is a decimal string. |
payout_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
payout_amount.value | JSON | Optional | |
payout_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
payout_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payout_date | string | Optional | Date the worker is paid, as an ISO 8601 date (YYYY-MM-DD). Null before a run is assigned. |
payout_method | string | Optional | How the worker is paid. `NOT_SET`: no payout run is assigned. `US_PAYROLL`: assigned to a US payroll run. `GLOBAL_PAYROLL`: assigned to a global payroll run. `DIRECT_DEPOSIT`: assigned to a direct deposit run. `EOR`: assigned to an employer-of-record payroll run. `MANUAL`: marked paid outside a run. If a payout method override is set, it is returned. Known values: NOT_SET, GLOBAL_PAYROLL, US_PAYROLL, DIRECT_DEPOSIT, EOR, MANUAL |
per_diem_line_items | array | Optional | Per diem sub-rate rows. Null except on per diem reimbursements. |
per_diem_line_items[] | Model | Each item | Expand Retrieve a specific reimbursement — response body — per diem line items item |
per_diem_rate | Model | Optional | Expand Retrieve a specific reimbursement — response body — per diem rate |
per_diem_rate_id | string | Optional | ID of the per diem rate. Null except on per diem reimbursements. Resolve it with `expand=per_diem_rate` on this reimbursement using `reimbursements.read`; there is no standalone rate lookup endpoint. |
receipt | object | Optional | Receipt file and its filename. |
receipt.file_name | string | Optional | Original file name, when recorded. |
receipt.url | string | Required within parent | URL for accessing the file. |
start_location | Model | Optional | Expand Retrieve a specific reimbursement — response body — start location |
transaction_date | string | Optional | When the purchase or authorization happened, as an ISO 8601 date-time in UTC. |
transaction_type | string | Optional | `REIMBURSEMENT`: an expense the worker paid and the company pays back. `MILEAGE_REIMBURSEMENT`: payback for distance driven. `PER_DIEM_REIMBURSEMENT`: payback for a daily travel allowance. This decides which mileage or per diem fields are set. Known values: REIMBURSEMENT, MILEAGE_REIMBURSEMENT, PER_DIEM_REIMBURSEMENT |
trip_end_date | string | Optional | Per diem trip end date, as an ISO 8601 date (YYYY-MM-DD). Null except on per diem reimbursements. |
trip_start_date | string | Optional | Per diem trip start date, as an ISO 8601 date (YYYY-MM-DD). Null except on per diem reimbursements. |
updated_at | string | Required within parent | Record update date |
vendor | Model | Optional | Expand Retrieve a specific reimbursement — response body — vendor |
vendor_id | string | Optional | ID of the Finance vendor. Use it with `/finance-vendors/{id}/`. |
waypoints | array | Optional | List of intermediate stops during the trip, for mileage reimbursements. Null except on mileage reimbursements. |
waypoints[] | Model | Each item | Expand Retrieve a specific reimbursement — response body — waypoints item |
worker | Model | Optional | Expand Retrieve a specific reimbursement — response body — worker |
worker_id | string | Optional | ID of the worker who made the transaction. Use it with `/workers/{id}/`. |
Referenced models: Retrieve a specific bill — response body — line items item, Retrieve a specific reimbursement — response body — waypoints item, Retrieve a specific reimbursement — response body — per diem line items item, Retrieve a specific bill — response body — attachments item, Retrieve a specific reimbursement — response body — end location, Retrieve a specific reimbursement — response body — mileage rate, Retrieve a specific reimbursement — response body — per diem rate, Retrieve a specific reimbursement — response body — start location, Retrieve a specific reimbursement — response body — vendor, Retrieve a specific reimbursement — response body — worker
List sandboxes — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
description | string | Optional | Optional sandbox description. |
handle | string | Optional | Server-generated sandbox handle. |
id | string | Required within parent | Identifier field |
name | string | Required within parent | Display name of the sandbox. |
status | string | Optional | Current lifecycle status. |
type | string | Required within parent | Sandbox type. Supported value: "developer". Known values: developer |
updated_at | string | Required within parent | Record update date |
List scheduled job assignments — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Platform API DTO for a scheduled job assignment or unassignment change. |
change_type | string | Optional | Type of scheduled change: ASSIGN or UNASSIGN. Known values: ASSIGN, UNASSIGN |
changed_by_id | string | Optional | The ID of the role that created this scheduled change. |
created_at | string | Required within parent | Record creation date |
effective_from | string | Optional | When the scheduled change will be applied (ISO 8601). |
id | string | Required within parent | Identifier field |
job_code_id | string | Optional | The ID of the job code. |
job_code_name | string | Optional | Display name of the job code. |
job_dimension_id | string | Optional | The ID of the job dimension. |
job_dimension_name | string | Optional | Display name of the job dimension. |
pay_rate | JSON | Optional | |
pay_rate (anyOf 1) | number | Alternative | New pay rate value, if the change includes a pay rate. |
pay_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
reason | string | Optional | Reason provided when the scheduled change was created. |
updated_at | string | Required within parent | Record update date |
worker_id | string | Optional | The ID of the worker (role) the scheduled changes target. |
List schedules — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
can_edit | boolean | Optional | Whether the requesting role can edit the schedule. |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
managers | array | Optional | The managers of the schedule. Expandable field |
managers[] | Model | Each item | Expand Retrieve a specific worker — response body — manager |
managers_id | array | Optional | The IDs of the managers of the schedule. |
managers_id[] | string | Each item | |
members | array | Optional | The members of the schedule. Expandable field |
members[] | Model | Each item | Expand Retrieve a specific worker — response body — manager |
members_id | array | Optional | The IDs of the members of the schedule. |
members_id[] | string | Each item | |
name | string | Optional | The name of the schedule. |
observers | array | Optional | The observers of the schedule. Expandable field |
observers[] | Model | Each item | Expand Retrieve a specific worker — response body — manager |
observers_id | array | Optional | The IDs of the observers of the schedule. |
observers_id[] | string | Each item | |
settings | object | Optional | The settings of the schedule. |
settings.timezone | string | Optional | The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
updated_at | string | Required within parent | Record update date |
Referenced models: Retrieve a specific worker — response body — manager
List selectable package component types — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
component_types | array | Required within parent | Selectable package component types and display names available to this role. |
component_types[] | Model | Each item | Expand List selectable package component types — response body — component types item |
Referenced models: List selectable package component types — response body — component types item
List selectable package component types — response body — component types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_name | string | Required within parent | Human-readable name of the component type. |
type | string | Required within parent | Component type accepted by the package component picker. |
List selectable package components — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
next_link | JSON | Required within parent | |
next_link (anyOf 1) | string | Alternative | URL for the next page of summaries, or null when there are no more results. |
next_link (anyOf 2) | null | Alternative | |
results | array | Required within parent | One page of component summaries, without configurations or source code. Maximum items: 100 |
results[] | Model | Each item | Expand List selectable package components — response body — results item |
Referenced models: List selectable package components — response body — results item
List selectable package components — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Component description, when available. |
description (anyOf 2) | null | Alternative | |
identifier | object | Required within parent | Complete package picker identifier to pass unchanged to extraction; fields depend on component type. |
name | string | Required within parent | Component display name in the package builder. |
selectable | boolean | Required within parent | Whether the package builder permits selecting this component. |
unsupported_reason | JSON | Required within parent | |
unsupported_reason (anyOf 1) | string | Alternative | Why selection is unavailable, when supplied by the package builder. |
unsupported_reason (anyOf 2) | null | Alternative |
List shift assignments — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
can_edit | boolean | Optional | Whether the shift assignment can be edited |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom fields for the shift assignment |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
id | string | Required within parent | Identifier field |
is_published | boolean | Required within parent | Whether the shift assignment is published. If true, the published_version will be the same as the shift_data |
published_version | Model | Optional | Expand Update a shift assignment — response body — published version |
schedule | Model | Optional | Expand Update a shift assignment — response body — schedule |
schedule_id | string | Required within parent | The ID of the schedule |
shift_data | Model | Required within parent | Expand Update a shift assignment — response body — shift data |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Update a shift assignment — response body — worker |
worker_id | string | Required within parent | The ID of the worker. Empty string '' to unassign if shift is from an open/empty shift. |
Referenced models: Update a shift assignment — response body — published version, Update a shift assignment — response body — schedule, Update a shift assignment — response body — shift data, Update a shift assignment — response body — worker
List shift inputs — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country_code | string | Required within parent | Two letter string designating country code which the shift input is associated. |
created_at | string | Required within parent | Record creation date |
creator | Model | Optional | Expand Update a shift input — response body — creator |
creator_id | string | Optional | The creator id associated with the shift input. |
id | string | Required within parent | Identifier field |
managed_by | string | Optional | The party that manages this shift input |
name | string | Required within parent | Name of the shift unit. |
prompt | string | Required within parent | Prompt for the shift unit. |
type | string | Required within parent | Type of shift unit. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a shift input — response body — creator
List software deployments — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active_group_type | string | Optional | Type of group targeting: 'Role' or 'Device'. Known values: Role, Device |
created_at | string | Required within parent | Record creation date |
group_id | string | Optional | Group ID for role-based targeting. Required if active_group_type is 'Role'. Must be null if 'Device'. |
id | string | Required within parent | Identifier field |
is_report_syncing_in_progress | boolean | Optional | Whether installation report syncing is in progress. When true, deployment status may be temporarily inconsistent. |
ma_device_group_id | string | Optional | Device group ID for device-based targeting. Required if active_group_type is 'Device'. Must be null if 'Role'. |
software | Model | Optional | Expand Update a software deployment — response body — software |
software_id | string | Required within parent | The ID of the software to deploy. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a software deployment — response body — software
List spend categories — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Spend category used to classify transaction line items. Inactive categories are included so historical transactions can still resolve their category. |
active | boolean | Optional | Whether the category is active. Inactive categories remain available for historical references. |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
name | string | Optional | Name of the Spend category. |
updated_at | string | Required within parent | Record update date |
List spend vendors — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A vendor in the company's Spend directory. Stub and archived vendors are included so historical transactions can still resolve their vendor. |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_archived | boolean | Optional | Whether the vendor is archived. Archived vendors remain available for historical references. |
logo | string | Optional | URL of the vendor's logo. Null when no logo is available. |
name | string | Optional | Canonical name of the Spend vendor. Name eq, ne, and in filters also match alternate names. |
updated_at | string | Required within parent | Record update date |
List supergroup members — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
full_name | string | Optional | The group member's full name. |
id | string | Required within parent | Identifier field |
updated_at | string | Required within parent | Record update date |
work_email | string | Optional | The group member's associated work email address. |
worker | object | Optional | The worker associated with this group member. Expandable field |
worker.business_partners | array | Optional | Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners. Expandable field |
worker.business_partners[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
worker.business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
worker.business_partners_id[] | string | Each item | |
worker.citizenship | string | Optional | The countries that the worker has citizenship in. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
worker.compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
worker.compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
worker.compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
worker.compensation_grade.label | string | Optional | The compensation grade's label. |
worker.compensation_id | string | Optional | The compensation package for the worker. |
worker.country | string | Optional | The worker's country. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
worker.country_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
worker.created_at | string | Required within parent | Record creation date |
worker.custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
worker.custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
worker.custom_fields[].* | JSON | Additional keys | |
worker.date_of_birth | string | Optional | The worker's date of birth. |
worker.department | Model | Optional | Expand Retrieve a specific worker — response body — department |
worker.department_id | string | Optional | The worker's assigned department. |
worker.employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
worker.employment_type_id | string | Optional | The worker's employment type. |
worker.end_date | string | Optional | The end date of the worker. |
worker.ethnicity | string | Optional | The identified ethnicity of the worker, if specified. Known values: HISPANIC_OR_LATINO, WHITE, BLACK_OR_AFRICAN_AMERICAN, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, ASIAN, AMERICAN_INDIAN_OR_ALASKA_NATIVE, TWO_OR_MORE_RACES, MIDDLE_EASTERN_OR_NORTH_AFRICAN, DECLINE_TO_SELF_IDENTIFY, AFRICAN, COLOURED, INDIAN, OTHER, PREFER_NOT_TO_SAY |
worker.gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
worker.id | string | Required within parent | Identifier field |
worker.is_manager | boolean | Optional | Whether the worker is a manager |
worker.job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
worker.job_function.created_at | string | Required within parent | Record creation date |
worker.job_function.id | string | Required within parent | Identifier field |
worker.job_function.name | string | Optional | Displayed name of the job function |
worker.job_function.updated_at | string | Required within parent | Record update date |
worker.job_function_id | string | Optional | ID of the worker's job function. |
worker.legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
worker.legal_entity_id | string | Optional | The worker's associated legal entity. |
worker.level | Model | Optional | Expand Retrieve a specific worker — response body — level |
worker.level_id | string | Optional | The level of the worker. |
worker.location | object | Optional | The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote. |
worker.location.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
worker.location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
worker.manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
worker.manager_id | string | Optional | The worker's manager. |
worker.number | JSON | Optional | |
worker.number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
worker.number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
worker.original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
worker.overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
worker.pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
worker.personal_email | string | Optional | The worker's associated personal email address. |
worker.race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
worker.start_date | string | Optional | The start date of the worker. |
worker.status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
worker.teams | array | Optional | The worker's assigned teams. Expandable field |
worker.teams[] | Model | Each item | Expand Update a team — response body — parent |
worker.teams_id | array | Optional | The worker's assigned teams. |
worker.teams_id[] | string | Each item | |
worker.termination_details | object | Optional | The details of the worker's termination, if applicable. |
worker.termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
worker.termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
worker.title | string | Optional | The worker's title. |
worker.title_effective_date | string | Optional | Title effective date |
worker.updated_at | string | Required within parent | Record update date |
worker.user | Model | Optional | Expand Retrieve a specific worker — response body — user |
worker.user_id | string | Optional | The worker's associated user. |
worker.work_email | string | Optional | The worker's associated work email address. |
worker.work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
worker.work_schedule.* | Model | Additional keys | Expand Retrieve a specific worker — response body — work schedule value |
worker_id | string | Optional | The worker's identifier associated with this group member. |
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
List supergroups — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allow_non_employees | boolean | Optional | Whether the group allows non employees |
app_owner_id | string | Optional | The id of the group's app owner. |
can_override_role_states | boolean | Optional | Whether the group can override role states |
created_at | string | Required within parent | Record creation date |
cumulatively_exhaustive_default | boolean | Optional | Whether the group is the cumulatively exhaustive default |
description | string | Optional | The group's description. |
display_name | string | Optional | The group's display name. |
group_type | string | Optional | The group type |
id | string | Required within parent | Identifier field |
ignore_prov_group_matching | boolean | Optional | Whether to ignore provisioning group matching when determining group membership |
include_terminated | boolean | Optional | Whether the group include terminated roles |
is_invisible | boolean | Optional | Whether the group is invisible |
mutually_exclusive_key | string | Optional | The group's mutually exclusive key |
name | string | Optional | The group's name. |
parent | string | Optional | The group's parent. |
priority | JSON | Optional | |
priority (anyOf 1) | integer | Alternative | The group's priority when calculating mutual exclusivity |
priority (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
read_only | boolean | Optional | Whether the group is read only. |
sub_group_type | string | Optional | The sub group type |
updated_at | string | Required within parent | Record update date |
List supported metadata types — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
types | array | Required within parent | Composer-enabled metadata component types. |
types[] | Model | Each item | Expand List supported metadata types — response body — types item |
Referenced models: List supported metadata types — response body — types item
List supported metadata types — response body — types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Short description of the component type. |
display_name | string | Required within parent | Human-readable component type name. |
type | string | Required within parent | Metadata component type. |
List time cards — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
pay_period | object | Optional | The pay period associated with the time card. |
pay_period.end_date | string | Optional | The end date of the pay period. |
pay_period.pay_schedule_id | string | Optional | The ID of the pay schedule associated with the pay period. |
pay_period.start_date | string | Optional | The start date of the pay period. |
summary | Model | Optional | Expand Retrieve a specific time card — response body — summary |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific time card — response body — worker |
worker_id | string | Required within parent | The ID of the worker associated with the time card. |
Referenced models: Retrieve a specific time card — response body — summary, Retrieve a specific time card — response body — worker
List time entries — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
breaks | array | Optional | The breaks taken during the time entry. |
breaks[] | Model | Each item | Expand Update a time entry — response body — breaks item |
comments | array | Optional | The comments associated with the time entry. |
comments[] | Model | Each item | Expand Update a time entry — response body — comments item |
create_extra_hours_run | boolean | Optional | Whether the time entry should create an extra hours run. |
created_at | string | Required within parent | Record creation date |
end_time | string | Optional | The end time of the time entry. |
id | string | Required within parent | Identifier field |
idempotency_key | string | Optional | The unique key of the time entry in an outside system. If set, no other time entry with the same key can be created. |
job_shifts | array | Optional | The job shifts worked during the time entry. |
job_shifts[] | Model | Each item | Expand Update a time entry — response body — job shifts item |
pay_period | object | Optional | The pay period associated with the time card. |
pay_period.end_date | string | Optional | The end date of the pay period. |
pay_period.pay_schedule_id | string | Optional | The ID of the pay schedule associated with the pay period. |
pay_period.start_date | string | Optional | The start date of the pay period. |
piece_rate_premiums | array | Optional | The piece-rate premiums earned during the time entry. |
piece_rate_premiums[] | Model | Each item | Expand Update a time entry — response body — piece rate premiums item |
premiums | array | Optional | The premiums earned during the time entry. |
premiums[] | Model | Each item | Expand Update a time entry — response body — premiums item |
segments | array | Optional | The pay rates for each segment of the time entry. |
segments[] | Model | Each item | Expand Update a time entry — response body — segments item |
shift_input_values | array | Optional | Arbitrary shift inputs collected on the time entry |
shift_input_values[] | Model | Each item | Expand Update a time entry — response body — shift input values item |
start_time | string | Optional | The start time of the time entry. |
status | string | Optional | The status of the time entry. Known values: DRAFT, APPROVED, PAID, FINALIZED |
tags | array | Optional | The tags associated with the time entry. |
tags[] | string | Each item | |
time_card | Model | Optional | Expand Update a time entry — response body — time card |
time_card_id | string | Optional | The ID of the time card associated with the time entry. |
time_entry_summary | Model | Optional | Expand Update a time entry — response body — time entry summary |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Update a time entry — response body — worker |
worker_id | string | Required within parent | The ID of the worker associated with the time entry. |
Referenced models: Update a time entry — response body — breaks item, Update a time entry — response body — job shifts item, Update a time entry — response body — piece rate premiums item, Update a time entry — response body — premiums item, Update a time entry — response body — segments item, Update a time entry — response body — shift input values item, Update a time entry — response body — comments item, Update a time entry — response body — time card, Update a time entry — response body — time entry summary, Update a time entry — response body — worker
List titles — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the title. |
updated_at | string | Required within parent | Record update date |
List tracks — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_default | boolean | Optional | Whether this is the company's default track. |
name | string | Required within parent | The name of the track. Must be unique within the company or organization. |
order | JSON | Optional | |
order (anyOf 1) | integer | Alternative | The one-based horizontal display order of the track. |
order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
start_global_level | JSON | Optional | |
start_global_level (anyOf 1) | integer | Alternative | The highest global level occupied by this track. Empty tracks return null. |
start_global_level (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Record update date |
List unassigned shifts — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assigned_count | JSON | Optional | |
assigned_count (anyOf 1) | integer | Alternative | The number of assigned shifts |
assigned_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
assigned_shift_ids | array | Optional | The IDs of the assigned shifts that are part of this unassigned shift |
assigned_shift_ids[] | string | Each item | |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom fields for the unassigned shift |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
id | string | Required within parent | Identifier field |
is_published | boolean | Required within parent | Whether the shift is published |
open_shift_config | object | Optional | Configuration for an open shift. If present, this is an open shift (workers can sign up). If absent/None, this is an empty shift (placeholder). |
published_version | Model | Optional | Expand Update a unassigned shift — response body — published version |
schedule | Model | Optional | Expand Update a shift assignment — response body — schedule |
schedule_id | string | Required within parent | The ID of the schedule |
shift_data | Model | Required within parent | Expand Update a shift assignment — response body — shift data |
target_count | JSON | Required within parent | |
target_count (anyOf 1) | integer | Alternative | The target count of the shift |
target_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a unassigned shift — response body — published version, Update a shift assignment — response body — schedule, Update a shift assignment — response body — shift data
List users — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active | boolean | Optional | Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding. |
addresses | array | Optional | The user's addresses. |
addresses[] | Model | Each item | Expand Retrieve a specific user — response body — addresses item |
created_at | string | Required within parent | Record creation date |
display_name | string | Optional | The display name of the user using either the concatenated preferred given and family name or username depending on availability. |
emails | array | Optional | The user's email addresses. |
emails[] | Model | Each item | Expand Retrieve a specific user — response body — emails item |
id | string | Required within parent | Identifier field |
locale | string | Optional | The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646. |
name | Model | Optional | Expand Retrieve a specific user — response body — name |
number | string | Optional | The permanent profile number of the user. |
phone_numbers | array | Optional | The user's phone numbers. |
phone_numbers[] | Model | Each item | Expand Retrieve a specific user — response body — phone numbers item |
photos | array | Optional | The user's photos. |
photos[] | Model | Each item | Expand Retrieve a specific user — response body — photos item |
preferred_language | string | Optional | The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231. |
timezone | string | Optional | The User's current time zone in IANA database Olson format |
updated_at | string | Required within parent | Record update date |
username | string | Optional | The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique. |
Referenced models: Retrieve a specific user — response body — emails item, Retrieve a specific user — response body — addresses item, Retrieve a specific user — response body — phone numbers item, Retrieve a specific user — response body — photos item, Retrieve a specific user — response body — name
List variable compensation payout labels — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client | string | Required within parent | Client system that created the label. |
external_id | string | Required within parent | External identifier unique per company and client. |
id | string | Required within parent | Unique identifier of the payout label. |
name | string | Required within parent | Display name of the label. |
List variable compensation payout types — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | string | Optional | ID of the worker who created this custom payout type. |
display_name | string | Required within parent | Display name of the payout type. |
id | string | Required within parent | Unique identifier of the payout type. Same as key. |
is_system | boolean | Required within parent | Whether this is a built-in payout type. |
key | string | Required within parent | Stable payout type key assigned by the server on create. |
mappings | array | Optional | Per-entity earning code mappings. |
mappings[] | Model | Each item | Expand Update a variable compensation payout type — response body — mappings item |
Referenced models: Update a variable compensation payout type — response body — mappings item
List variable compensation payouts — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount_base | object | Required within parent | Payout amount in the worker's base currency. |
amount_base.currency_type | string | Required within parent | Three-letter currency code. |
amount_base.value | string | Required within parent | Decimal amount encoded as a string. |
amount_usd | object | Required within parent | Payout amount converted to USD. |
amount_usd.currency_type | string | Required within parent | Three-letter currency code. |
amount_usd.value | string | Required within parent | Decimal amount encoded as a string. |
cancel_reason | string | Optional | Reason provided when the payout was cancelled. |
client | string | Required within parent | Client system that created the payout. Known values: VC_PLAN_CYCLE, VC_EVENT_DRIVEN_PLAN, CUSTOM, MANUAL_PAYOUT, HRIS_SIGN_ON, OFFLINE_RECOMMENDATION |
created_at | string | Required within parent | When the payout was created. |
description | string | Optional | Optional payout description. |
effective_end_date | string | Required within parent | End date of the covered pay period. |
effective_start_date | string | Required within parent | Start date of the covered pay period. |
external_id | string | Required within parent | External identifier unique per company and client. |
group_label_id | string | Optional | Group label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed. |
id | string | Required within parent | Unique identifier of the payout. |
name | string | Optional | Optional payout name. |
pay_classification | string | Optional | Payroll earning code resolved from the payout type. |
payee_id | string | Required within parent | ID of the worker who receives this payout. Expandable payee (Worker DTO + workers.read) is deferred from v1; use GET /workers/{id}/ when needed. |
payout_type | string | Required within parent | Key of the company payout type used for this payout. Expand is deferred from v1; enumerate valid keys via GET /variable-compensation-payout-types/. |
paystub_id | string | Optional | Paystub identifier when the payout has been synced to payroll. |
scheduled_date | string | Required within parent | Date on which the payout is scheduled. |
source_label_id | string | Optional | Source label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed. |
status | string | Required within parent | Current payout status. Known values: DRAFT, PENDING_APPROVAL, APPROVAL_REJECTED, SCHEDULED, RELEASED, PAID, FORFEITED, EVALUATION_FAILED, CANCELLED |
updated_at | string | Required within parent | When the payout was last updated. |
List visible activity log events retained from the last 90 days — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | One visible Activity Log event retained from the last 90 days. |
actor_type | string | Optional | The kind of actor that initiated the event. WORKER is a Rippling worker; INTERNAL_BY_WORKER is an internal API request triggered by a worker; SYSTEM is an automated Rippling system process; EXTERNAL is an external system or integration; RIPPLING_MDM is Rippling MDM; PARTNER is a Rippling partner, but the partner identity is not returned; and PROXY is Rippling staff or support acting through proxy. Null when no actor type was recorded. Known values: WORKER, SYSTEM, EXTERNAL, INTERNAL_BY_WORKER, RIPPLING_MDM, PARTNER, PROXY |
created_at | string | Required within parent | Record creation date |
event_type | string | Optional | The open UPPER_SNAKE_CASE Activity Log code, such as USER_LOGIN_SUCCESS. New codes can appear over time. |
id | string | Required within parent | Identifier field |
occurred_at | string | Optional | The activity occurrence time as an ISO 8601 UTC timestamp. Unlike created_at, which records when the Activity Log record was persisted, occurred_at records when the underlying activity happened. |
reason | object | Optional | Why the activity occurred. Null when no reason was recorded. |
reason.code | string | Optional | The machine-readable reason code recorded for the event. Null when no reason was recorded. |
reason.message | string | Optional | The human-readable meaning of the reason code. Null when no reason was recorded. |
request_context | Model | Optional | Expand Retrieve a specific activity log event — response body — request context |
source_app_handle | string | Optional | The public app handle used by GET /app-users/ for the Rippling app associated with the activity. Null when the activity is not app-specific. |
status | string | Optional | The outcome of the activity. SUCCESS means the activity completed successfully; FAILURE means the activity failed. Null when no outcome was recorded. Known values: SUCCESS, FAILURE |
targets | array | Optional | The resources affected by the activity. Empty when no targets were recorded. |
targets[] | Model | Each item | Expand Retrieve a specific activity log event — response body — targets item |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific activity log event — response body — worker |
worker_id | string | Optional | The Platform worker ID from GET /workers/{id}/ when the actor is a worker. Null when the actor is not a worker. |
Referenced models: Retrieve a specific activity log event — response body — targets item, Retrieve a specific activity log event — response body — request context, Retrieve a specific activity log event — response body — worker
List work locations — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Required within parent | Expand Update a work location — response body — address |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the work location. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a work location — response body — address
List worker change fields — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category | string | Required within parent | High-level grouping for the field. Known values: PERSONAL, JOB, COMPENSATION, BENEFITS, CUSTOM, COUNTRY_SPECIFIC |
field_display_name | string | Required within parent | UI label for the field (English). |
field_key | string | Required within parent | Field key in snake_case. Use directly in ?filter=field_key eq '...' on GET /worker-changes. Naming convention: public DTO fields use the DTO field name verbatim (work_email, title); nested fields use dot notation (compensation.base_salary); custom fields use custom_fields.<custom_field_id>; country-specific fields use country_fields.<field_name>. Filter semantics: filtering GET /worker-changes by field_key returns events that contain at least one change to this field, but the changes[] array on those events is NOT pruned — consumers receive the full event payload including changes to other fields. |
value_type | string | Required within parent | Value type of the field. Known values: STRING, NUMBER, BOOLEAN, DATE, DATETIME, CURRENCY, ENUM, REFERENCE |
List worker changes — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applied_on | string | Required within parent | When the change was persisted (approval time for changes that went through an approval workflow). UTC. Monotonically increasing as new commits land; use as the cursor axis for incremental polling. |
changed_by | Model | Optional | Expand Retrieve a specific worker change — response body — changed by |
changed_by_id | string | Optional | Actor who made the change. Null for system-initiated events. |
changes | array | Required within parent | Field-level changes captured by this event. Per-field REDACTED entries appear for fields the caller cannot read so consumers can detect that a change occurred even when the value is hidden. Events where every changed field is invisible to the caller — either internal fields not exposed via the public Object Graph, or fields the caller's role has zero read permission on — are dropped from the response entirely (they never appear with an all-REDACTED changes array). |
changes[] | Model | Each item | Expand Retrieve a specific worker change — response body — changes item |
created_at | string | Required within parent | Record creation date |
effective_on | string | Required within parent | When the change is true in the business domain. Can be past, present, or future. Independent of applied_on. UTC. |
event_type | string | Required within parent | The lifecycle event type this change represents. CHANGE is the catch-all for non-lifecycle field edits. Known values: HIRE, CHANGE, SCHEDULED_CHANGE, OFFBOARD, SCHEDULED_OFFBOARD, IMPORT, UNDO, EFFECTIVE_DATE_AMENDMENT |
id | string | Required within parent | Identifier field |
import_type | string | Optional | INITIAL (census import at company onboarding) or HISTORICAL (historical data imported later). Set only when event_type is IMPORT. Known values: INITIAL, HISTORICAL |
reason_code | string | Optional | Structured transition reason (e.g. 'PROMOTION', 'MARKET_ADJUSTMENT'). Populated only when the company has configured transition reasons and the change went through a role transition with one selected. Null for most companies and events. |
referenced_transaction_id | string | Optional | For amendments or undos, the id of the worker-change event being modified. |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific worker change — response body — worker |
worker_id | string | Required within parent | The worker affected by this change. |
Referenced models: Retrieve a specific worker change — response body — changes item, Retrieve a specific worker change — response body — changed by, Retrieve a specific worker change — response body — worker
List worker time splits — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker time split configuration resource. |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_enabled | boolean | Optional | Whether hard-coded time splits are active for this worker. |
job_codes | array | Optional | The job codes referenced in this time split configuration. Use ?expand=job_codes to populate. Expandable field |
job_codes[] | Model | Each item | Expand List job codes — response body — results item |
job_codes_id | array | Optional | IDs of all unique job codes referenced across all split rows. |
job_codes_id[] | string | Each item | |
splits | array | Optional | The split rows defining time allocation percentages across job codes. Empty when is_enabled is false. |
splits[] | Model | Each item | Expand Update a worker time split — response body — splits item |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Update a worker time split — response body — worker |
worker_id | string | Required within parent | Identifier of the worker whose time split configuration this represents. |
Referenced models: List job codes — response body — results item, Update a worker time split — response body — splits item, Update a worker time split — response body — worker
List worker-payroll-records — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | V2 DTO representing earnings, deductions, taxes, and garnishments for a single worker in a payroll run. Used by: - GET /payroll-runs/{run_id}/worker-payroll-records/ (list) - GET /payroll-runs/{run_id}/worker-payroll-records/{id} (retrieve) |
country_code | string | Optional | ISO country code where this payroll record applies. |
currency | string | Optional | ISO currency code for monetary amounts in this record. |
deductions | array | Optional | List of deduction line items. |
deductions[] | Model | Each item | Expand List worker-payroll-records — response body — results item deductions item |
earnings | array | Optional | List of earning line items. |
earnings[] | Model | Each item | Expand List worker-payroll-records — response body — results item earnings item |
garnishments | array | Optional | List of garnishment line items. |
garnishments[] | Model | Each item | Expand List worker-payroll-records — response body — results item garnishments item |
gross_pay | string | Optional | Gross pay amount for the current period. |
id | string | Optional | Unique identifier for this payroll record (PRE version ID). |
net_pay | string | Optional | Net pay amount for the current period. |
run_id | string | Optional | Identifier of the payroll run this record belongs to. |
summary | object | Optional | Aggregate totals for taxes, deductions, and garnishments. |
summary.employee_deductions | string | Optional | Total employee deductions. |
summary.employee_taxes | string | Optional | Total employee-paid taxes. |
summary.employer_contributions | string | Optional | Total employer contributions (e.g. retirement matching). |
summary.employer_taxes | string | Optional | Total employer-paid taxes. |
summary.total_garnishments | string | Optional | Total garnishments withheld. |
taxes | array | Optional | List of tax line items. |
taxes[] | Model | Each item | Expand List worker-payroll-records — response body — results item taxes item |
worker_id | string | Optional | Identifier of the worker (role ID). |
Referenced models: List worker-payroll-records — response body — results item deductions item, List worker-payroll-records — response body — results item earnings item, List worker-payroll-records — response body — results item garnishments item, List worker-payroll-records — response body — results item taxes item
List worker-payroll-records — response body — results item deductions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single deduction line item on a worker's payroll record. |
deduction_code | string | Optional | Code identifying the deduction type. |
display_name | string | Optional | Human-readable name of the deduction. |
employee_amount | string | Optional | Employee contribution amount for the current period. |
employer_amount | string | Optional | Employer contribution amount for the current period. |
List worker-payroll-records — response body — results item earnings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single earning line item on a worker's payroll record. |
amount | string | Optional | Earning amount for the current period. |
display_name | string | Optional | Human-readable name of the earning. |
earning_category | string | Optional | Category of the earning (e.g. SALARY, HOURLY). |
earning_code | string | Optional | Code identifying the earning type (e.g. regular_salary). |
hours | string | Optional | Hours worked for this earning in the current period. |
rate | string | Optional | Hourly rate applied to this earning. |
time_labels | array | Optional | Time tracking labels associated with this earning. |
time_labels[] | string | Each item |
List worker-payroll-records — response body — results item garnishments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single garnishment line item on a worker's payroll record. |
amount | string | Optional | Garnishment amount for the current period. |
garnishment_code | string | Optional | Code identifying the garnishment. |
List worker-payroll-records — response body — results item taxes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single tax line item on a worker's payroll record. |
amount | string | Optional | Tax amount for the current period. |
display_name | string | Optional | Human-readable name of the tax. |
paid_by | string | Optional | Who pays this tax: EMPLOYER or EMPLOYEE. |
tax_code | string | Optional | Unique code identifying the tax. |
List workflows — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
next_link | JSON | Optional | |
next_link (anyOf 1) | string | Alternative | |
next_link (anyOf 2) | null | Alternative | |
results | array | Required within parent | |
results[] | Model | Each item | Expand List workflows — response body — results item |
Referenced models: List workflows — response body — results item
List workflows — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
created_at | string | Required within parent | Format: date-time |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
enabled | boolean | Required within parent | |
has_draft | boolean | Required within parent | |
id | string | Required within parent | |
name | string | Required within parent | |
owner_id | string | Required within parent | |
status | string | Required within parent | Known values: draft, published, unknown |
updated_at | string | Required within parent | Format: date-time |
version_id | string | Required within parent |
Retrieve a package sandbox link — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request to link a package to a sandbox, or poll an EDIT-mode installation tracker. |
created_at | string | Required within parent | Record creation date |
error_message | string | Optional | Error message when EDIT-mode linking failed |
id | string | Required within parent | Identifier field |
installation_record_id | string | Optional | Installation record ID when EDIT-mode linking completes |
installation_tracker_id | string | Optional | The internal sandbox installation tracker ID |
mode | string | Required within parent | How the sandbox is linked to the package (INSTALL or EDIT) |
package_key | string | Required within parent | The package key to link into the sandbox |
package_version_id | string | Optional | The package version being linked in EDIT mode |
post_install_landing_component | object | Optional | Component to open after EDIT-mode linking completes |
progress | array | Optional | EDIT-mode installation progress entries |
progress[] | JSON | Each item | Additional keys: see wildcard field |
progress[].* | JSON | Additional keys | |
sandbox_company_id | string | Required within parent | The company receiving the sandbox package installation |
status | string | Optional | INSTALL completion status, or EDIT installation tracker status |
updated_at | string | Required within parent | Record update date |
Retrieve a report run — response body — meta redacted fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Info about the redacted fields. |
name | string | Optional | The name for the redacted field |
reason | string | Optional | The reason for the redaction |
Retrieve a report — response body — output fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An attribute (column) in the report output |
field_id | string | Required within parent | Stable field identifier |
field_name | string | Required within parent | Human-readable display name of the output field |
Retrieve a report — response body — saved filters item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A filter currently saved on the report |
field_id | string | Required within parent | Stable field identifier the filter applies to |
field_name | string | Required within parent | Human-readable display name of the filtered field |
operator | string | Required within parent | Filter operator applied to the field |
value | JSON | Optional | |
value (anyOf 1) | JSON | Alternative | Filter value; shape depends on the operator |
value (anyOf 2) | null | Alternative |
Retrieve a specific activity log event — response body — request context
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request and approximate location details captured for the activity. Null for non-request events. |
accuracy_radius | JSON | Optional | |
accuracy_radius (anyOf 1) | number | Alternative | The accuracy radius of the IP-derived location in kilometers. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved. |
accuracy_radius (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
browser | string | Optional | The browser family parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable. |
city | string | Optional | The city resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved. |
country | string | Optional | The country resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved. |
device | string | Optional | The device family parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable. |
ip_address | string | Optional | The IPv4 or IPv6 address associated with the request. Null without the activity-log.sensitive-data.read scope. |
latitude | JSON | Optional | |
latitude (anyOf 1) | number | Alternative | The approximate latitude in decimal degrees resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved. |
latitude (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
longitude | JSON | Optional | |
longitude (anyOf 1) | number | Alternative | The approximate longitude in decimal degrees resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved. |
longitude (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
operating_system | string | Optional | The operating system parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable. |
state | string | Optional | The state or region resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved. |
Retrieve a specific activity log event — response body — targets item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A resource or internal entity affected by an Activity Log event. |
id | string | Optional | The ID of the resource affected by the event. Null when the event target has no referenced resource. Filtering by targets.id is not supported for GROUP or SPOKE_USER targets. |
type | string | Optional | The kind of target. WORKER uses the worker ID from GET /workers/{id}/; DEVICE uses the device ID from GET /devices/{id}/; GROUP uses the group ID from GET /supergroups/{id}/; SPOKE_USER uses the app-user ID from GET /app-users/{id}/. COMPUTER is deprecated in favor of DEVICE and its ID is not a Platform resource ID. IDs for SPOKE, RPASS_ITEM, RPASS_FOLDER, SCHEDULED_CHANGE, BDR_POLICY, AUTH_RULE, COMPANY_AUTH_RULE, USER_ACCOUNT, HARDWARE_SCRIPT, HARDWARE_CONFIGURATION, SOFTWARE_UPDATE, OS_SOFTWARE_UPDATE, WORK_EMAIL_POLICY, OFFBOARDING_POLICY, REMOTE_ACCESS_SESSION_OPTIONS, and REMOTE_ACCESS_SESSION_ERROR_DETAILS are not Platform resource IDs. Known values: WORKER, SPOKE, RPASS_ITEM, SPOKE_USER, GROUP, RPASS_FOLDER, SCHEDULED_CHANGE, COMPUTER, BDR_POLICY, AUTH_RULE, COMPANY_AUTH_RULE, DEVICE, USER_ACCOUNT, HARDWARE_SCRIPT, HARDWARE_CONFIGURATION, SOFTWARE_UPDATE, OS_SOFTWARE_UPDATE, WORK_EMAIL_POLICY, OFFBOARDING_POLICY, REMOTE_ACCESS_SESSION_OPTIONS, REMOTE_ACCESS_SESSION_ERROR_DETAILS |
Retrieve a specific activity log event — response body — worker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worker who initiated the activity. Request with expand=worker and the workers.read OAuth scope to return the Worker resource. Expandable field |
business_partners | array | Optional | Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners. Expandable field |
business_partners[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
business_partners_id[] | string | Each item | |
citizenship | string | Optional | The countries that the worker has citizenship in. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
compensation_grade.label | string | Optional | The compensation grade's label. |
compensation_id | string | Optional | The compensation package for the worker. |
country | string | Optional | The worker's country. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
country_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
created_at | string | Required within parent | Record creation date |
custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
custom_fields[].* | JSON | Additional keys | |
date_of_birth | string | Optional | The worker's date of birth. |
department | Model | Optional | Expand Retrieve a specific worker — response body — department |
department_id | string | Optional | The worker's assigned department. |
employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
employment_type_id | string | Optional | The worker's employment type. |
end_date | string | Optional | The end date of the worker. |
ethnicity | string | Optional | The identified ethnicity of the worker, if specified. Known values: HISPANIC_OR_LATINO, WHITE, BLACK_OR_AFRICAN_AMERICAN, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, ASIAN, AMERICAN_INDIAN_OR_ALASKA_NATIVE, TWO_OR_MORE_RACES, MIDDLE_EASTERN_OR_NORTH_AFRICAN, DECLINE_TO_SELF_IDENTIFY, AFRICAN, COLOURED, INDIAN, OTHER, PREFER_NOT_TO_SAY |
gender | string | Optional | The gender of the worker, if specified. Known values: MALE, FEMALE, NONBINARY, UNDETERMINED, DIVERSE, DOES_NOT_APPLY, PREFER_NOT_TO_SAY |
id | string | Required within parent | Identifier field |
is_manager | boolean | Optional | Whether the worker is a manager |
job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
job_function.created_at | string | Required within parent | Record creation date |
job_function.id | string | Required within parent | Identifier field |
job_function.name | string | Optional | Displayed name of the job function |
job_function.updated_at | string | Required within parent | Record update date |
job_function_id | string | Optional | ID of the worker's job function. |
legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
legal_entity_id | string | Optional | The worker's associated legal entity. |
level | Model | Optional | Expand Retrieve a specific worker — response body — level |
level_id | string | Optional | The level of the worker. |
location | object | Optional | The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote. |
location.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
manager_id | string | Optional | The worker's manager. |
number | JSON | Optional | |
number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
personal_email | string | Optional | The worker's associated personal email address. |
race | string | Optional | The identified race of the worker, if specified. Known values: BLACK, BROWN, CHINESE, EURASIAN, INDIAN, INDIGENOUS, MALAY, WHITE, YELLOW, NOT_INFORMED, OTHER |
start_date | string | Optional | The start date of the worker. |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
teams | array | Optional | The worker's assigned teams. Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | The worker's assigned teams. |
teams_id[] | string | Each item | |
termination_details | object | Optional | The details of the worker's termination, if applicable. |
termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
termination_details.type | string | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY, RETIREMENT, DEATH, ABANDONMENT, OFFER_DECLINED, RESCIND, RENEGE |
title | string | Optional | The worker's title. |
title_effective_date | string | Optional | Title effective date |
updated_at | string | Required within parent | Record update date |
user | Model | Optional | Expand Retrieve a specific worker — response body — user |
user_id | string | Optional | The worker's associated user. |
work_email | string | Optional | The worker's associated work email address. |
work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
work_schedule.* | Model | Additional keys | Expand Retrieve a specific worker — response body — work schedule value |
Referenced models: Retrieve a specific worker — response body — business partners item, Update a team — response body — parent, Retrieve a specific worker — response body — work schedule value, Retrieve a specific worker — response body — manager, Retrieve a specific worker — response body — compensation, Retrieve a specific worker — response body — country fields, Retrieve a specific worker — response body — department, Retrieve a specific worker — response body — employment type, Retrieve a specific worker — response body — legal entity, Retrieve a specific worker — response body — level, Retrieve a specific worker — response body — user