Rippling: Rest API schemas (part 3)
75 Rippling schemas with complete fields and constraints.
← Rest API operations · All schemas
Evaluate a leave program evaluation — response body — program results item directives
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Bookable directives emitted by this program. |
balance_adjustments | array | Optional | Balance adjustment directives emitted by payable program results. |
balance_adjustments[] | Model | Each item | Expand Evaluate a leave program evaluation — response body — leave plan balance adjustments item |
earnings | array | Optional | Payroll earning directives emitted by payable program results. |
earnings[] | Model | Each item | Expand Evaluate a leave program evaluation — response body — leave plan earnings item |
leave_request | Model | Optional | Expand Evaluate a leave program evaluation — response body — program results item directives leave request |
Referenced models: Evaluate a leave program evaluation — response body — leave plan balance adjustments item, Evaluate a leave program evaluation — response body — leave plan earnings item, Evaluate a leave program evaluation — response body — program results item directives leave request
Evaluate a leave program evaluation — response body — program results item directives leave request
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Leave request directive emitted by payable program results. |
end_date | string | Optional | Recommended leave request end date, if known. |
leave_type | string | Required within parent | Leave type to use if booking a leave request from the evaluation. |
start_date | string | Required within parent | Recommended leave request start date. |
status | string | Optional | Optional leave request status to use when booking. |
Evaluate a leave program evaluation — response body — program results item pay rate phases item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | Pay amount for this phase serialized as a decimal string. |
currency | string | Optional | ISO 4217 currency code for this pay phase. |
duration_days | JSON | Optional | |
duration_days (anyOf 1) | integer | Alternative | Number of days this phase lasts. Null means the phase runs to the window end. |
duration_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unit | string | Optional | Pay-rate unit for this phase, such as DAILY, WEEKLY, or BIWEEKLY. |
Evaluate a leave program evaluation — response body — program results item program requirements item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
blocks_payment | boolean | Optional | Whether this requirement blocks payment until resolved. |
key | string | Required within parent | Machine-readable requirement key. |
summary | string | Required within parent | Human-readable requirement summary. |
Evaluate a leave program evaluation — response body — program results item program validations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data_source | string | Optional | Evidence key or field path inspected by the validation. |
message | string | Required within parent | Human-readable validation message. |
outcome | string | Required within parent | Validation outcome. Known values: PASSED, FAILED, UNKNOWN, ASSUMED |
validation_func | string | Required within parent | Machine-readable validation function that produced this outcome. |
value | string | Optional | Observed value at evaluation time, if available. |
Execute a workflow action from Rippling Functions — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action_type | string | Required within parent | One of: run_query |
payload | Model | Required within parent | Expand Execute a workflow action from Rippling Functions — request body — body payload |
workflow_definition_id | string | Required within parent |
Referenced models: Execute a workflow action from Rippling Functions — request body — body payload
Execute a workflow action from Rippling Functions — request body — body payload
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
product_name | JSON | Optional | |
product_name (anyOf 1) | string | Alternative | |
product_name (anyOf 2) | null | Alternative | |
query | string | Required within parent |
Execute a workflow — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single execution of a workflow: one launch of the workflow's current published version, with a status to poll until it reaches a terminal value. Additional keys: not allowed |
created_at | string | Required within parent | When the workflow was launched, in UTC (ISO 8601). Format: date-time |
id | string | Required within parent | Unique identifier for this workflow execution. Poll it with GET /workflows/{id}/executions/{execution_id}. |
status | string | Required within parent | The execution status. Transitional values are `pending`, `in_progress`, `waiting_for_response`, and `cancellation_pending`; terminal values are `completed`, `failed`, and `cancelled`. Poll until the status reaches a terminal value. * `pending`: The execution is queued and has not started. * `in_progress`: The workflow is executing. * `waiting_for_response`: The execution is paused on a human input or approval step. * `cancellation_pending`: A cancellation was requested and is being applied. * `completed`: Every step finished successfully. * `failed`: The execution stopped on an error. * `cancelled`: The execution was cancelled before completing. * `unknown`: The status could not be mapped. Contact support if this persists. Known values: pending, in_progress, completed, failed, cancelled, cancellation_pending, waiting_for_response, unknown |
version_id | string | Required within parent | The workflow version that ran. An execution always runs the workflow's current published version; the current version_id is available from GET /workflows/{id}. |
workflow_id | string | Required within parent | The ID of the workflow this execution belongs to. Matches the {id} path parameter. |
Export a package version manifest — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
components | array | Required within parent | Complete desired component snapshot compiled from the Metadata SDK's defineManifest. Each entry requires its component type and full configuration for that type. An empty array creates an empty draft version; it cannot be published until components are added. |
components[] | object | Each item | |
components_to_delete | array | Optional | Must be omitted or an empty array. Versions are complete snapshots, so deletion instructions are rejected. Default: [] Maximum items: 0 |
components_to_delete[] | object | Each item | |
metadata | Model | Required within parent | Expand Export a package version manifest — response body — metadata |
Referenced models: Export a package version manifest — response body — metadata
Export a package version manifest — response body — metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Source metadata from the SDK's defineManifest, retained with the snapshot. Use an empty object when no metadata is needed; package identity is supplied separately. Additional keys: not allowed |
description | string | Optional | Optional description of the source manifest, independent of the version description. |
key | string | Optional | Optional source-manifest identifier, retained on download; not the package key. |
name | string | Optional | Optional source-manifest label, retained on download; does not rename the package. |
Extract existing metadata components — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
component_configs | array | Required within parent | Readable component configs for the selected roots. Dependencies the caller cannot read are omitted, so the result may not be deployable as-is. |
component_configs[] | Model | Each item | Expand Extract existing metadata components — response body — component configs item |
context_complete | boolean | Optional | For search-backed extraction, whether contextual expansion completed without warnings or unreadable components being omitted. |
context_warnings | array | Optional | Warnings from search-backed contextual expansion. |
context_warnings[] | string | Each item | |
dependency_graph | object | Required within parent | Serialized dependency graph for the extracted package. Additional keys: allowed |
external_managed_dependencies | array | Optional | |
external_managed_dependencies[] | object | Each item | External managed dependency. Additional keys: allowed |
install_order | array | Required within parent | Topological install order for the extracted package. |
install_order[] | object | Each item | Component identifier. Additional keys: allowed |
root_components | array | Required within parent | Components selected as extraction roots. |
root_components[] | Model | Each item | Expand Extract existing metadata components — response body — root components item |
Referenced models: Extract existing metadata components — response body — component configs item, Extract existing metadata components — response body — root components item
Extract existing metadata components — response body — component configs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A metadata component config. The `type` field selects the concrete component schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>. Additional keys: allowed |
type | string | Required within parent | Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD. |
Extract existing metadata components — response body — root components item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Selectable package root returned by metadata extraction. Additional keys: allowed |
identifier | object | Optional | Identifier for the selected component. Additional keys: allowed |
name | string | Optional | Display name for the selectable component. |
Extract live package components and dependencies — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
identifiers | array | Required within parent | Complete picker identifiers; fields depend on the component type. Maximum items: 100 Minimum items: 1 |
identifiers[] | object | Each item |
Extract live package components and dependencies — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
component_configs | array | Required within parent | Full packaging configurations for selected live components and their dependencies. |
component_configs[] | object | Each item | |
external_managed_dependencies | array | Required within parent | Required components owned by other managed packages, outside this snapshot. |
external_managed_dependencies[] | object | Each item | |
external_zobject_references | array | Required within parent | Native object and field references required in the destination company. |
external_zobject_references[] | object | Each item | |
has_omitted_unreadable_components | boolean | Required within parent | True when extraction skipped a missing, deleted, or unreadable component, including a selected root or dependency. The returned snapshot is partial and must not be used to create a package version. |
install_order | array | Required within parent | Component identifiers ordered for installation by the packaging dependency graph. |
install_order[] | object | Each item | |
omitted_components | array | Required within parent | Missing or deleted components skipped by the shared extractor, with identifiers and omission reasons. An empty list means no missing-component omissions were reported. |
omitted_components[] | Model | Each item | Expand Extract live package components and dependencies — response body — omitted components item |
Referenced models: Extract live package components and dependencies — response body — omitted components item
Extract live package components and dependencies — response body — omitted components item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
identifier | object | Required within parent | Identifier of the selected component or dependency omitted from extraction. |
message | string | Required within parent | Explanation of why the component was omitted. |
reason | string | Required within parent | Machine-readable reason the component was omitted. Known values: NOT_FOUND |
Extract metadata components by identifier — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
identifiers | array | Required within parent | Minimum items: 1 |
identifiers[] | object | Each item | Exact metadata component identifier, including its type. Additional keys: allowed |
Extract metadata components by identifier — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
component_configs | array | Required within parent | Readable component configs for the requested roots. Unreadable dependencies are omitted, so the result may not be deployable as-is. |
component_configs[] | Model | Each item | Expand Extract existing metadata components — response body — component configs item |
external_managed_dependencies | array | Required within parent | |
external_managed_dependencies[] | object | Each item | External managed dependency. Additional keys: allowed |
install_order | array | Required within parent | Topological install order for the extracted package. |
install_order[] | object | Each item | Component identifier. Additional keys: allowed |
Referenced models: Extract existing metadata components — response body — component configs item
Get a metadata schema — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
best_practices | string | Optional | Type-specific implementation guidance. |
common_mistakes | array | Optional | Common invalid inputs and their corrections. |
common_mistakes[] | Model | Each item | Expand Get a metadata schema — response body — common mistakes item |
config_schema | object | Required within parent | JSON Schema for a full deployable component config. Additional keys: allowed |
description | string | Optional | Short description of the component type. |
display_name | string | Optional | Human-readable component type name. |
examples | array | Optional | Valid example configs for this component type. |
examples[] | object | Each item | Example metadata component config. Additional keys: allowed |
identifier_schema | object | Required within parent | JSON Schema for identifying an existing component. Additional keys: allowed |
type | string | Required within parent | Metadata component type. |
usage_guide | string | Optional | Type-specific authoring guidance. |
Referenced models: Get a metadata schema — response body — common mistakes item
Get a metadata schema — response body — common mistakes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Required within parent | Explanation of the correction. |
right | string | Required within parent | Corrected example. |
wrong | string | Required within parent | Invalid or discouraged example. |
Get a package version — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
components | array | Optional | Components included in this version. Function identifiers provide valid post_install_function values. |
components[] | object | Each item | Additional keys: allowed |
components[].identifier | object | Required within parent | Additional keys: allowed |
components[].identifier.api_name | string | Optional | The portable API name. Present on FUNCTION identifiers; other component kinds may use different identity fields. |
components[].identifier.type | string | Required within parent | The component kind. FUNCTION identifies a packaged Function. |
created_at | string | Required within parent | Record creation date |
description | string | Optional | The description of the package version |
id | string | Required within parent | Identifier field |
is_published | boolean | Optional | Whether this package version has been published |
package_display_name | string | Optional | The display name of the parent package |
package_id | string | Optional | The ID of the parent package |
package_key | string | Optional | The package key of the parent package |
post_install_function | JSON | Optional | |
post_install_function (anyOf 1) | string | Alternative | The portable API name of a Function component included in this version. Find valid values in components entries with identifier.type equal to FUNCTION, using identifier.api_name. Set through PATCH on an unpublished version after adding the Function. Creation rejects this field. Null clears the hook and omission preserves it. Removing the Function clears the setting when the version is refreshed or copied. |
post_install_function (anyOf 2) | null | Alternative | |
updated_at | string | Required within parent | Record update date |
version_number | string | Required within parent | The semantic version number for this package version |
Get hire requirements — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Public GET /hire-requirements/ body. Shape matches hiring's catalog JSON. Additional keys: not allowed |
country_code | string | Required within parent | ISO 3166-1 alpha-2 country code used for the lookup. |
fields_by_group | array | Required within parent | Hiring-owned field catalog grouped by request section. |
hire_type | string | Required within parent | Hire type for this catalog. POST /hires/ uses the same value. An omitted POST value defaults to direct_hire. |
required_groups | array | Required within parent | Groups you must send for this country. |
required_groups[] | string | Each item | |
requirements_version | string | Required within parent | Baseline requirement contract version for this selector tuple. |
unsupported_fields | array | Optional | Public field paths that are not writable for this selector tuple. |
unsupported_fields[] | string | Each item | |
warnings | array | Optional | Non-fatal warnings for this lookup. |
warnings[] | string | Each item |
Get the company and administrator role used to enter a developer sandbox — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Company and administrator role used to enter a developer sandbox. |
admin_role_id | JSON | Required within parent | |
admin_role_id (anyOf 1) | string | Alternative | The unique identifier of the sandbox company's administrator role. |
admin_role_id (anyOf 2) | null | Alternative | |
target_company_id | JSON | Required within parent | |
target_company_id (anyOf 1) | string | Alternative | The unique identifier of the company inside the sandbox. |
target_company_id (anyOf 2) | null | Alternative |
List App Shop publisher users — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | App Shop Publishers Super Group member. |
email | string | Optional | The publisher's work or invite email |
full_name | string | Optional | The publisher's full name |
id | string | Optional | Role ID of a member of the App Shop Publishers Super Group |
is_super_admin | boolean | Optional | Whether this publisher is a Super Admin |
role_state | string | Optional | Role state: INIT, HIRED, ACCEPTED, ACTIVE, or TERMINATED Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
List Custom App — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
api_name | string | Required within parent | The unique api name of the custom app |
created_at | string | Optional | Record creation date |
description | string | Optional | The description of the custom app |
icon | string | Optional | The icon URL of the custom app |
id | string | Optional | Identifier field |
name | string | Required within parent | The display name of the custom app |
pages | array | Optional | The pages of the custom app |
pages[] | Model | Each item | Expand Update a Custom App — response body — pages item |
updated_at | string | Optional | Record update date |
Referenced models: Update a Custom App — response body — pages item
List Custom Page — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Record creation date |
created_by | string | Optional | The ID of the role that created the page |
function_id | string | Optional | The ID of the Rippling Function that renders this page |
id | string | Optional | Identifier field |
name | string | Optional | The display name of the custom page |
updated_at | string | Optional | Record update date |
updated_by | string | Optional | The ID of the role that last modified the page |
List Setting — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
api_name | string | Optional | The unique api name of the setting |
boolean_value | boolean | Optional | Boolean value of the setting, if it has boolean data type |
created_at | string | Required within parent | Record creation date |
data_type | string | Optional | Data type of the setting |
display_name | string | Optional | The display name of setting |
id | string | Required within parent | Identifier field |
number_value | JSON | Optional | |
number_value (anyOf 1) | number | Alternative | Number value of the setting, if it has number data type |
number_value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
secret_value | string | Optional | Secret value of the setting, if it has secret data type |
string_value | string | Optional | String value of the setting, if it has string data type |
updated_at | string | Required within parent | Record update date |
List Sites — response body — meta
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of redacted fields. |
redacted_fields | array | Optional | |
redacted_fields[] | object | Each item | |
redacted_fields[].name | string | Optional | The name for the redacted field |
redacted_fields[].reason | string | Optional | The reason for the redaction |
List Sites — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response/resource shape for a custom site. |
admin_group_id | string | Optional | The admin group id for the custom site |
api_name | string | Optional | The unique api name of the custom site |
created_at | string | Optional | Record creation date |
created_by | string | Optional | The ID of the role that created the custom site |
current_bundle_id | string | Optional | The active bundle id for the custom site |
description | string | Optional | The optional description of the custom site |
id | string | Optional | Identifier field |
logo | string | Optional | A Rippling-owned logo URL for the custom site |
name | string | Optional | The display name of the custom site |
viewer_group_id | string | Optional | The viewer group id for the custom site |
List agent deployments — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deployment_id | string | Optional | The ID of the deployment |
diagnostics | array | Optional | Diagnostics emitted while creating the deployment |
diagnostics[] | Model | Each item | Expand Retrieve an agent deployment — response body — diagnostics item |
is_active | boolean | Optional | Whether the deployment is active |
outcome | string | Optional | The deployment outcome |
source_digest | string | Optional | The digest of the deployed source revision |
source_revision_version | JSON | Optional | |
source_revision_version (anyOf 1) | integer | Alternative | The source revision version deployed by the control plane |
source_revision_version (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
stage | string | Optional | The deployment stage |
Referenced models: Retrieve an agent deployment — response body — diagnostics item
List agent session events — response body — events item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | When the event was created |
event_id | string | Optional | The ID of the session event |
event_type | string | Optional | The event type |
fields | object | Optional | Structured event fields |
level | string | Optional | The event severity level |
message | string | Optional | The event message |
sequence | JSON | Optional | |
sequence (anyOf 1) | integer | Alternative | The event sequence number |
sequence (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List agent sessions — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agent_id | string | Required within parent | The ID of the agent to run |
created_at | string | Required within parent | Record creation date |
error_message | string | Optional | The session error message |
id | string | Required within parent | Identifier field |
langsmith_thread_id | string | Optional | The stable LangSmith thread identifier for this session |
output | object | Optional | The output of the session |
prompt | string | Required within parent | The prompt to send to the agent |
session_resume_receipt | object | Optional | Receipt that ACP restored the requested session resume state |
session_resume_receipt.status | string | Optional | The session resume state restore status |
status | string | Optional | The status of the session. Possible values: `awaiting_approval`: someone else requested this session on your behalf, and it is waiting for your approval before it starts; `active`: the agent is running; `idle`: the session is open and waiting for more work; `waiting_on_user`: the agent is waiting for user input; `suspended`: the session is paused; `completed`: the session finished successfully; `ended`: the session was explicitly ended; `failed`: execution failed or the approval request expired or became invalid before execution; `cancelled`: execution was cancelled or the approval request was rejected or cancelled. The Platform API does not support requesting delegated execution or managing approvals. |
submission_id | string | Optional | Receipt for correlating agent.submission.settled events after create or append-message writes |
updated_at | string | Required within parent | Record update date |
List agent source revisions — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List representation of an agent source revision without source contents. |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
source_digest | string | Optional | The digest of the source revision |
updated_at | string | Required within parent | Record update date |
version | JSON | Optional | |
version (anyOf 1) | integer | Alternative | The version number of the source revision |
version (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List agents — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
api_name | string | Required within parent | The API name of the agent |
created_at | string | Required within parent | Record creation date |
description | string | Optional | The description of the agent |
id | string | Required within parent | Identifier field |
is_for_evals | boolean | Optional | Whether the agent is used for evaluations |
name | string | Required within parent | The display name of the agent |
updated_at | string | Required within parent | Record update date |
List app users — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Maps a Rippling worker (if any) to their user account in a third-party app (e.g. Slack, Jira, GitHub). Sourced from SpokeUser records. Includes orphan accounts — third-party app accounts with no matching Rippling worker (`worker_id=None`, `match_state=NOT_MATCHED`). These are the primary signal for IT-admin triage. Uses `BaseResourceDTO` rather than `BaseEmployeeResourceDTO` so the platform's role-based auto-filter does not silently drop orphans for non-admin tokens. Company scoping is enforced explicitly in `AppUsersAPIViewSet.get_queryset`; the `app-users.read` scope is the access gate. Resource name aligns with how the product surfaces these in the UI ("Slack account", "GitHub account") and matches the equivalent concept in Okta's IAM API (AppUser). Designed for point lookups: list endpoint requires at least one filter on `worker_id` or `spoke_user_identifier` to prevent bulk enumeration of the org's identity graph across connected apps. `spoke_user_identifier` reads `SpokeUser.spokeId` — the user identifier stored for the third-party account. Depending on the integration, this may be an email, username, account handle, or app-specific user id. |
app_display_name | string | Optional | Human-readable display name for the third-party app (e.g. 'Slack', 'GitHub'). Sourced from the customer-configured SpokeOwner.app_display_name; falls back to a title-cased app handle when the customer hasn't set one. |
app_handle | string | Optional | Machine-readable identifier for the third-party app (e.g. 'slack', 'jira', 'asana'). Stable across the App Shop catalog. |
created_at | string | Required within parent | Record creation date |
external_email | string | Optional | The user's email address in the third-party app, if known. Null when the app does not expose an email or Rippling did not capture one. |
external_username | string | Optional | The user's display name in the third-party app, if known. Null when the app does not surface a separate username. |
id | string | Required within parent | Identifier field |
match_state | string | Optional | Whether this third-party account has been matched to a Rippling worker. Known values: MATCHED, NOT_MATCHED, IGNORED |
push_state | string | Optional | Provisioning lifecycle state of this account in the third-party app. Known values: INIT, EMPLOYEE_CONFIRMATION_PENDING, EMPLOYEE_CONFIRMATION_ACCEPTED, EMPLOYEE_CONFIRMATION_REJECTED, INVITE_PENDING, INVITE_CONFIRMED, INVITE_FAILED, CREATE_PENDING, CREATE_CONFIRMED, CREATE_FAILED, DELETE_PENDING, DELETE_CONFIRMED, DELETE_FAILED, SUSPEND_PENDING, SUSPEND_CONFIRMED, SUSPEND_FAILED |
spoke_user_identifier | string | Optional | Identifier for the user's account in the third-party app workspace. Depending on the integration, this may be an email, username, account handle, or app-specific user id. |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific app user — response body — worker |
worker_id | string | Optional | ID of the Rippling worker associated with this external app account. |
Referenced models: Retrieve a specific app user — response body — worker
List attribute change logs — rest Api list Job Codes Job Code Id Change Log — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attribute_changes | array | Optional | List of attributes that were modified as part of the change. |
attribute_changes[] | Model | Each item | Expand List attribute change logs — rest Api list Job Codes Job Code Id Change Log — response body — results item attribute changes item |
changed_by_worker | object | Optional | Worker who made the change Expandable field |
changed_by_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 |
changed_by_worker.business_partners[] | Model | Each item | Expand Retrieve a specific worker — response body — business partners item |
changed_by_worker.business_partners_id | array | Optional | Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners. |
changed_by_worker.business_partners_id[] | string | Each item | |
changed_by_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 |
changed_by_worker.compensation | Model | Optional | Expand Retrieve a specific worker — response body — compensation |
changed_by_worker.compensation_grade | object | Optional | The compensation grade assigned to the worker, if any. |
changed_by_worker.compensation_grade.id | string | Optional | The compensation grade's unique identifier. |
changed_by_worker.compensation_grade.label | string | Optional | The compensation grade's label. |
changed_by_worker.compensation_id | string | Optional | The compensation package for the worker. |
changed_by_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 |
changed_by_worker.country_fields | Model | Optional | Expand Retrieve a specific worker — response body — country fields |
changed_by_worker.created_at | string | Required within parent | Record creation date |
changed_by_worker.custom_fields | array | Optional | Custom field values defined on the Employee object for this worker Expandable field |
changed_by_worker.custom_fields[] | JSON | Each item | Additional keys: see wildcard field |
changed_by_worker.custom_fields[].* | JSON | Additional keys | |
changed_by_worker.date_of_birth | string | Optional | The worker's date of birth. |
changed_by_worker.department | Model | Optional | Expand Retrieve a specific worker — response body — department |
changed_by_worker.department_id | string | Optional | The worker's assigned department. |
changed_by_worker.employment_type | Model | Optional | Expand Retrieve a specific worker — response body — employment type |
changed_by_worker.employment_type_id | string | Optional | The worker's employment type. |
changed_by_worker.end_date | string | Optional | The end date of the worker. |
changed_by_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 |
changed_by_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 |
changed_by_worker.id | string | Required within parent | Identifier field |
changed_by_worker.is_manager | boolean | Optional | Whether the worker is a manager |
changed_by_worker.job_function | object | Optional | The worker's job function. When expanded, this field requires `job-functions.read`. Expandable field |
changed_by_worker.job_function.created_at | string | Required within parent | Record creation date |
changed_by_worker.job_function.id | string | Required within parent | Identifier field |
changed_by_worker.job_function.name | string | Optional | Displayed name of the job function |
changed_by_worker.job_function.updated_at | string | Required within parent | Record update date |
changed_by_worker.job_function_id | string | Optional | ID of the worker's job function. |
changed_by_worker.legal_entity | Model | Optional | Expand Retrieve a specific worker — response body — legal entity |
changed_by_worker.legal_entity_id | string | Optional | The worker's associated legal entity. |
changed_by_worker.level | Model | Optional | Expand Retrieve a specific worker — response body — level |
changed_by_worker.level_id | string | Optional | The level of the worker. |
changed_by_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. |
changed_by_worker.location.type | string | Required within parent | The type of location. Known values: REMOTE, WORK |
changed_by_worker.location.work_location_id | string | Required within parent | The work location, if the worker isn't remote. |
changed_by_worker.manager | Model | Optional | Expand Retrieve a specific worker — response body — manager The worker's manager. Expandable field |
changed_by_worker.manager_id | string | Optional | The worker's manager. |
changed_by_worker.number | JSON | Optional | |
changed_by_worker.number (anyOf 1) | integer | Alternative | The worker's number within the organization. |
changed_by_worker.number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
changed_by_worker.original_start_date | string | Optional | The worker's earliest start date across their employment history, excluding INIT roles. |
changed_by_worker.overtime_exemption | string | Optional | The worker's overtime exemption status. Known values: EXEMPT, NON_EXEMPT |
changed_by_worker.pay_schedule_id | string | Optional | The ID of the pay schedule currently associated with the worker. |
changed_by_worker.personal_email | string | Optional | The worker's associated personal email address. |
changed_by_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 |
changed_by_worker.start_date | string | Optional | The start date of the worker. |
changed_by_worker.status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
changed_by_worker.teams | array | Optional | The worker's assigned teams. Expandable field |
changed_by_worker.teams[] | Model | Each item | Expand Update a team — response body — parent |
changed_by_worker.teams_id | array | Optional | The worker's assigned teams. |
changed_by_worker.teams_id[] | string | Each item | |
changed_by_worker.termination_details | object | Optional | The details of the worker's termination, if applicable. |
changed_by_worker.termination_details.reason | string | Optional | This is a description that will be custom to each Rippling company. |
changed_by_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 |
changed_by_worker.title | string | Optional | The worker's title. |
changed_by_worker.title_effective_date | string | Optional | Title effective date |
changed_by_worker.updated_at | string | Required within parent | Record update date |
changed_by_worker.user | Model | Optional | Expand Retrieve a specific worker — response body — user |
changed_by_worker.user_id | string | Optional | The worker's associated user. |
changed_by_worker.work_email | string | Optional | The worker's associated work email address. |
changed_by_worker.work_schedule | object | Optional | The worker's scheduled working hours for each day of the week. Additional keys: see wildcard field |
changed_by_worker.work_schedule.* | Model | Additional keys | Expand Retrieve a specific worker — response body — work schedule value |
changed_by_worker_id | string | Optional | Identifier of worker who made the change |
created_at | string | Optional | The time the change was requested by worker |
effective_from_date | string | Optional | The time the change was scheduled to take effect on |
id | string | Required within parent | Identifier field |
reason | string | Optional | Reason provided by worker for making the change |
updated_at | string | Optional | The time the change was applied |
Referenced models: List attribute change logs — rest Api list Job Codes Job Code Id Change Log — response body — results item attribute changes item, 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 attribute change logs — rest Api list Job Codes Job Code Id Change Log — response body — results item attribute changes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attribute_name | string | Optional | The name of attribute changed. |
new_attribute_value | object | Optional | New value of attribute, after the change |
old_attribute_value | object | Optional | Old value of attribute, before the change. |
List available filters for a report — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes a field the client can filter on when running a report |
field_id | string | Required within parent | Stable field identifier used when applying filters |
field_name | string | Required within parent | Human-readable display name of the field |
operators | array | Required within parent | Operators supported by this field |
operators[] | string | Each item | |
type | string | Required within parent | Data type of a filterable field Known values: string, number, date, datetime, enum, boolean |
List background check candidates — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Background Check Candidate DTO. Represents a candidate who has been submitted for background check screening. Required on Create (but nullable on read for legacy rows): - email: Required for new candidates, but may be null on read for legacy rows - external_id: Required for new candidates, but may be null on read for legacy rows Optional Fields: - owner_id: May be null if no provider is associated - first_name: May be null if name is not available - last_name: May be null if name is not available - middle_name: May be null if not provided Sensitive Fields: - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model - These do not require separate OAuth scopes beyond the resource-level scopes (background-check-candidates.read / .read-write) because they are not updating role or worker data, only storing candidate names for background check processing Note: first_name, last_name, and middle_name are NOT filterable. Only external_id, email, created_at, and updated_at support filtering. |
created_at | string | Optional | The timestamp when the candidate was created. |
email | string | Required within parent | The email address of the candidate. Required on create, but may be null on read for legacy rows. |
external_id | string | Required within parent | The provider's unique identifier for the candidate. Required on create, but may be null on read for legacy rows. Can only be set once (during creation or when null). Cannot be changed after being set. |
first_name | string | Optional | The first name of the candidate. |
id | string | Optional | The unique identifier of the background check candidate. |
last_name | string | Optional | The last name of the candidate. |
middle_name | string | Optional | The middle name of the candidate. |
owner_id | string | Optional | The ID of the background check provider (OAuth spoke owner). |
updated_at | string | Optional | The timestamp when the candidate was last updated. |
List bill payments — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A bill payment visible to the caller, including its invoice and payment details. |
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 state of the bill. `DRAFT`: not submitted. `PENDING`: awaiting required information before submission. `REQUESTED`: awaiting approval. `APPROVED`: approved. `REJECTED`: rejected. `FINALIZED`: finalized for payment. `ACTIONED`: paid. `CANCELLED`: cancelled. `FAILED`: payment failed. Known values: DRAFT, PENDING, REQUESTED, APPROVED, REJECTED, FINALIZED, ACTIONED, CANCELLED, FAILED |
attachments | array | Optional | URLs of other attached files. |
attachments[] | string | Each item | |
check_date | string | Optional | Date the company is debited, as an ISO 8601 date. Null when not set. |
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 |
credit_method | string | Optional | How the vendor is paid: ACH, WIRE, CHECK, GLOBAL_ORDER, EXISTING_CORPORATE_CARD, or MANUALLY_PAID. Known values: ACH, WIRE, CHECK, GLOBAL_ORDER, EXISTING_CORPORATE_CARD, MANUALLY_PAID, PAID_IN_FULL_VIA_VENDOR_CREDIT |
debit_method | string | Optional | How the company is debited: ACH, WIRE, EXISTING_CORPORATE_CARD, or MANUALLY_PAID. Known values: ACH, WIRE, EXISTING_CORPORATE_CARD, MANUALLY_PAID |
due_date | string | Optional | Invoice due date, as an ISO 8601 date. A draft can omit it. |
entity_id | string | Optional | ID of the legal entity the transaction belongs to. Use it with `/company-legal-entities/{id}/`. |
estimated_payment_arrival | string | Optional | When the vendor is expected to receive the payment, as an ISO 8601 date-time in UTC. Null when not set. |
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. |
global_purpose | string | Optional | Purpose code for an international payment. Null for domestic payments. |
id | string | Required within parent | Identifier field |
invoice_number | string | Optional | Invoice number. Null when the bill has no invoice number. |
line_items | array | Optional | Bill line items, including accounting, tax, quantity, and term details. |
line_items[] | Model | Each item | Expand Retrieve a specific bill payment — 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]+)?$ |
parent_bill_id | string | Optional | ID of the bill this payment was split from. Use it with `/bill-payments/{id}/`. Null when it is not a split bill. |
payment_amount | object | Optional | Amount paid to the vendor, in the payment currency. The value is a decimal string. |
payment_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
payment_amount.value | JSON | Optional | |
payment_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
payment_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payment_method_fee | object | Optional | Payment method fee, in the company's headquarters currency. The `value` is a decimal string. Zero when there is no fee. |
payment_method_fee.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
payment_method_fee.value | JSON | Optional | |
payment_method_fee.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
payment_method_fee.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payment_schedule_setting | string | Optional | SCHEDULE_NOW when a debit date was chosen; SKIP_FOR_NOW when choosing one was skipped. Known values: SCHEDULE_NOW, SKIP_FOR_NOW |
payment_velocity | string | Optional | How fast the vendor is paid after `check_date`: `TWO_DAY` (accelerated, 2 business days) or `FOUR_DAY` (standard, 4 business days). Known values: TWO_DAY, FOUR_DAY |
receipt | string | Optional | URL of the receipt file. |
scheduled_payment_date | string | Optional | Date used to estimate vendor payment, as an ISO 8601 date. Null when not set. |
submitter_id | string | Optional | ID of the bill manager who submitted the bill. Use it with `/workers/{id}/`. Can differ from `worker_id`. Null before submission. |
transaction_date | string | Optional | Invoice date, as an ISO 8601 date-time in UTC. Null when not set. |
transaction_type | string | Optional | Type of transaction: `BILL_PAYMENT`. Known values: BILL_PAYMENT |
updated_at | string | Required within parent | Record update date |
vendor | object | Optional | Vendor the purchase was made from. |
vendor.id | string | Optional | ID of the vendor. |
vendor.name | string | Optional | Name of the vendor. |
vendor_memo | string | Optional | Memo included on the payment to the vendor. Supported for ACH; null when not set. |
vendor_paid_date | string | Optional | Date the vendor is paid, as an ISO 8601 date. Null until paid. |
worker_id | string | Optional | ID of the worker who made the transaction. Use it with `/workers/{id}/`. |
Referenced models: Retrieve a specific bill payment — response body — line items item
List bills — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A bill visible to the caller, including its invoice and payment details. |
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 state of the bill. `DRAFT`: not submitted. `PENDING`: awaiting required information before submission. `REQUESTED`: awaiting approval. `APPROVED`: approved. `REJECTED`: rejected. `FINALIZED`: finalized for payment. `ACTIONED`: paid. `CANCELLED`: cancelled. `FAILED`: payment failed. 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 |
credit_method | string | Optional | How the vendor is paid: ACH, WIRE, CHECK, GLOBAL_ORDER, EXISTING_CORPORATE_CARD, MANUALLY_PAID, or PAID_IN_FULL_VIA_VENDOR_CREDIT. GLOBAL_ORDER is an international transfer. PAID_IN_FULL_VIA_VENDOR_CREDIT means vendor credits cover the full bill, with no cash payment. Known values: ACH, WIRE, CHECK, GLOBAL_ORDER, EXISTING_CORPORATE_CARD, MANUALLY_PAID, PAID_IN_FULL_VIA_VENDOR_CREDIT |
due_date | string | Optional | Invoice due date, as an ISO 8601 date. A draft can omit it. |
entity_id | string | Optional | ID of the legal entity the transaction belongs to. Use it with `/company-legal-entities/{id}/`. |
estimated_payment_arrival | string | Optional | Date the vendor is expected to receive the payment, as an ISO 8601 date. Null when not set. |
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 |
invoice | object | Optional | Invoice file and its filename. |
invoice.file_name | string | Optional | Original file name, when recorded. |
invoice.url | string | Required within parent | URL for accessing the file. |
invoice_date | string | Optional | Invoice date, as an ISO 8601 date (YYYY-MM-DD). Null when not set. Filters compare UTC calendar days: `eq` includes the whole day, `gt` starts the following day, and `lt` excludes the specified day. `ge` and `le` include the specified day; `in` matches any listed day. |
invoice_number | string | Optional | Invoice number. Null when the bill has no invoice number. |
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]+)?$ |
parent_bill_id | string | Optional | ID of the bill this payment was split from. Use it with `/bills/{id}/`. Null when it is not a split bill. |
payment_amount | object | Optional | Amount paid to the vendor, in the payment currency. The `value` is a decimal string. |
payment_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
payment_amount.value | JSON | Optional | |
payment_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
payment_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payment_method_fee | object | Optional | Payment method fee, in the company's headquarters currency. The `value` is a decimal string. Zero when there is no fee. |
payment_method_fee.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
payment_method_fee.value | JSON | Optional | |
payment_method_fee.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
payment_method_fee.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payment_schedule_setting | string | Optional | Payment scheduling choice: `SCHEDULE_NOW` to schedule payment, or `SKIP_FOR_NOW` to defer scheduling. Known values: SCHEDULE_NOW, SKIP_FOR_NOW |
payment_velocity | string | Optional | Payment speed option: `TWO_DAY` (accelerated) or `FOUR_DAY` (standard). Use `estimated_payment_arrival` for the expected arrival date. Known values: TWO_DAY, FOUR_DAY |
scheduled_payment_date | string | Optional | Date used to estimate vendor payment, as an ISO 8601 date. Null when not set. |
submitter | Model | Optional | Expand Retrieve a specific bill — response body — submitter |
submitter_id | string | Optional | ID of the bill manager who submitted the bill. Use it with `/workers/{id}/`. Can differ from `worker_id`. Null before submission. |
transaction_type | string | Optional | Type of transaction: `BILL_PAYMENT`. Known values: BILL_PAYMENT |
updated_at | string | Required within parent | Record update date |
vendor | Model | Optional | Expand Retrieve a specific bill — response body — vendor |
vendor_id | string | Optional | ID of the Finance vendor. Use it with `/finance-vendors/{id}/`. |
vendor_memo | string | Optional | Memo included on the payment to the vendor. Supported for ACH; null when not set. |
vendor_paid_date | string | Optional | Date the vendor is paid, as an ISO 8601 date. Null until paid. |
worker | Model | Optional | Expand Retrieve a specific bill — 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 bill — response body — attachments item, Retrieve a specific bill — response body — submitter, Retrieve a specific bill — response body — vendor, Retrieve a specific bill — response body — worker
List break policies — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country_code | string | Optional | ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB'). |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_default | boolean | Optional | Whether this is a system-seeded default policy (true) or a custom policy created by an admin (false). |
name | string | Required within parent | The display name of the break policy. For default policies this is the system-generated label (e.g. 'Default Break policy: All Workers | California'); for custom policies this is the admin-provided description. |
updated_at | string | Required within parent | Record update date |
List break types — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
break_category | string | Optional | The break category. One of: MEAL, REST, or OTHER. Known values: MEAL, REST, OTHER |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_paid | boolean | Optional | Whether this is a paid break (true) or unpaid (false). |
name | string | Required within parent | The display name of the break type. |
policy | Model | Optional | Expand Retrieve a specific break type — response body — policy |
policy_id | string | Optional | The ID of the break policy this break type belongs to. |
updated_at | string | Required within parent | Record update date |
Referenced models: Retrieve a specific break type — response body — policy
List business partner groups — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
default_business_partner | Model | Optional | Expand Create a new business partner group — response body — default business partner |
default_business_partner_id | string | Optional | Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group. |
domain | string | Optional | Type of business partner group Known values: HR, IT, FINANCE, RECRUITING, OTHER |
id | string | Required within parent | Identifier field |
name | string | Required within parent | Name used to identify business partner group |
updated_at | string | Required within parent | Record update date |
Referenced models: Create a new business partner group — response body — default business partner
List business partners — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_partner_group | Model | Optional | Expand Create a new business partner — response body — business partner group |
business_partner_group_id | string | Required within parent | Identifier of business partner group the business parter is a part of |
client_group | Model | Optional | Expand Create a new business partner — response body — client group |
client_group_id | string | Optional | Identifier of group of workers associated with the business partner |
client_group_member_count | JSON | Optional | |
client_group_member_count (anyOf 1) | integer | Alternative | Number of workers associated with the business partner |
client_group_member_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Create a new business partner — response body — worker |
worker_id | string | Required within parent | Identifier of worker who is the business partner |
Referenced models: Create a new business partner — response body — business partner group, Create a new business partner — response body — client group, Create a new business partner — response body — worker
List candidate applications — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applied_at | string | Optional | Application creation date |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
job | object | Optional | Job requisition Expandable field |
job.created_at | string | Required within parent | Record creation date |
job.id | string | Required within parent | Identifier field |
job.name | string | Required within parent | Job requisition name |
job.status | string | Required within parent | Job requisition status Known values: OPEN, CLOSED, PUBLISHED, DRAFT, ARCHIVED |
job.updated_at | string | Required within parent | Record update date |
job_id | string | Optional | Job requisition ID |
stage | string | Optional | Application stage |
status | string | Optional | Application status Known values: ACTIVE, REJECTED, HIRED, ARCHIVED |
updated_at | string | Required within parent | Record update date |
url | string | Optional | Application url |
List candidates — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
email | string | Optional | Candidate email |
first_name | string | Optional | Candidate first name |
id | string | Required within parent | Identifier field |
last_name | string | Optional | Candidate last name |
phone_number | string | Optional | Candidate phone number |
timezone | string | Optional | Candidate timezone |
updated_at | string | Required within parent | Record update date |
List card transactions — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Finance card transaction or authorization the caller can see. An authorization is a pending hold the card network places at the time of purchase. A card transaction is the posted charge. List returns both; retrieve returns one by ID. A transaction 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 |
authorization_state | string | Optional | State of the card authorization. `PENDING`: an active hold awaiting completion. `CLOSED`: the authorization completed and the charge posted. `REVERSED`: the authorization was reversed and the hold released. `EXPIRED`: the hold expired without completion. Null for posted card transactions. Known values: PENDING, CLOSED, REVERSED, EXPIRED |
card_id | string | Optional | ID of the Finance card used. No public API is currently available to retrieve this card. |
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 |
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]+)?$ |
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. |
transaction_date | string | Optional | When the purchase or authorization happened, as an ISO 8601 date-time in UTC. |
transaction_type | string | Optional | `CARD_TRANSACTION`: a posted card charge. `CARD_AUTHORIZATION`: a hold placed by the card network before the charge posts. Known values: CARD_TRANSACTION, CARD_AUTHORIZATION |
updated_at | string | Required within parent | Record update date |
vendor | Model | Optional | Expand Retrieve a specific card transaction — response body — vendor |
vendor_id | string | Optional | ID of the Finance vendor. Use it with `/finance-vendors/{id}/`. |
worker | Model | Optional | Expand Retrieve a specific card transaction — 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 bill — response body — attachments item, Retrieve a specific card transaction — response body — vendor, Retrieve a specific card transaction — response body — worker
List companies — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
doing_business_as_name | string | Optional | The doing business as name for the company. |
id | string | Required within parent | Identifier field |
legal_entities | array | Required within parent | A list of the company's entities. Expandable field |
legal_entities[] | Model | Each item | Expand Retrieve my SSO information — response body — company legal entities item |
legal_entities_id | array | Required within parent | A list of the company's entities. |
legal_entities_id[] | string | Each item | |
legal_name | string | Optional | The legal name of the company. |
name | string | Required within parent | The name of the company. |
parent_legal_entity | Model | Optional | Expand Retrieve my SSO information — response body — company parent legal entity |
parent_legal_entity_id | string | Optional | The company's ultimate holding entity. |
phone | string | Optional | The phone number for the company. |
physical_address | Model | Optional | Expand Retrieve my SSO information — response body — company physical address |
primary_email | string | Optional | The email address used when registering this company. |
updated_at | string | Required within parent | Record update date |
Referenced models: Retrieve my SSO information — response body — company legal entities item, Retrieve my SSO information — response body — company parent legal entity, Retrieve my SSO information — response body — company physical address
List company legal entities — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
company_id | string | Optional | The company associated with this entity relationship. |
country_code | string | Optional | The ISO country code for the entity. |
created_at | string | Required within parent | Record creation date |
entity_level | string | Optional | The entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity. Known values: PARENT, SUBSIDIARY, BRANCH |
id | string | Required within parent | Identifier field |
is_archived | boolean | Optional | True if this entity relationship has been archived. |
is_cor | boolean | Optional | True if this entity is managed as a Contractor of Record. |
is_eor | boolean | Optional | True if this entity is managed as an Employer of Record. |
is_peo | boolean | Optional | True if this entity is managed as a Professional Employment Organization. |
legal_name | string | Optional | The legal name of the entity. |
mailing_address | Model | Optional | Expand Retrieve a specific company legal entity — response body — mailing address |
management_type | string | Optional | The entity management type. * `EOR`: The entity is managed as an Employer of Record. * `COR`: The entity is managed as a Contractor of Record. * `PEO`: The entity is managed as a Professional Employment Organization. * `null`: The entity is a direct hire with no managed employment type. Known values: PEO, EOR, COR |
physical_address | Model | Optional | Expand Retrieve a specific company legal entity — response body — physical address |
registration_date | string | Optional | The registration date of the entity. |
tax_identifier | string | Optional | The tax identifier for this entity. |
updated_at | string | Required within parent | Record update date |
Referenced models: Retrieve a specific company legal entity — response body — mailing address, Retrieve a specific company legal entity — response body — physical address
List company-legal-entity-workers — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
company_entity_id | string | Optional | The worker's associated company legal entity (CER ID). |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
status | string | Optional | The worker's status within the organization. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
updated_at | string | Required within parent | Record update date |
List compensation bands details — 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 |
internal_job_code | string | Optional | Internal job code |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific compensation bands detail — response body — worker |
worker_id | string | Optional | ID of the worker associated with compensation bands |
Referenced models: Retrieve a specific compensation bands detail — response body — worker
List compensations — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
annual_compensation | object | Optional | The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage. |
annual_compensation.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
annual_compensation.value | JSON | Optional | |
annual_compensation.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
annual_compensation.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
annual_salary_equivalent | object | Optional | The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation. |
annual_salary_equivalent.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
annual_salary_equivalent.value | JSON | Optional | |
annual_salary_equivalent.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
annual_salary_equivalent.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
bonus_schedule | string | Optional | The worker's bonus schedule. |
created_at | string | Required within parent | Record creation date |
hourly_wage | object | Optional | The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation. |
hourly_wage.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
hourly_wage.value | JSON | Optional | |
hourly_wage.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
hourly_wage.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Identifier field |
monthly_compensation | object | Optional | The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage. |
monthly_compensation.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
monthly_compensation.value | JSON | Optional | |
monthly_compensation.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
monthly_compensation.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
on_target_commission | object | Optional | The worker's on-target commission. |
on_target_commission.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
on_target_commission.value | JSON | Optional | |
on_target_commission.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
on_target_commission.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payment_terms | string | Optional | The payment terms for an worker's compensation. |
payment_type | string | Optional | The payment type for an worker's compensation. |
relocation_reimbursement | object | Optional | The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation. |
relocation_reimbursement.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
relocation_reimbursement.value | JSON | Optional | |
relocation_reimbursement.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
relocation_reimbursement.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
salary_effective_date | string | Optional | Salary effective date |
signing_bonus | object | Optional | The worker's signing bonus. |
signing_bonus.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
signing_bonus.value | JSON | Optional | |
signing_bonus.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
signing_bonus.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
target_annual_bonus | object | Optional | The worker's target annual bonus amount. |
target_annual_bonus.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
target_annual_bonus.value | JSON | Optional | |
target_annual_bonus.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
target_annual_bonus.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
target_annual_bonus_percent | JSON | Optional | |
target_annual_bonus_percent (anyOf 1) | number | Alternative | The worker's target annual bonus as a percent of annual compensation. |
target_annual_bonus_percent (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Record update date |
weekly_compensation | object | Optional | The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage. |
weekly_compensation.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
weekly_compensation.value | JSON | Optional | |
weekly_compensation.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
weekly_compensation.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
worker | Model | Optional | Expand Retrieve a specific compensation — response body — worker |
worker_id | string | Optional | The worker's ID. |
Referenced models: Retrieve a specific compensation — response body — worker
List custom fields — 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 field. |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the custom field. |
options | array | Optional | The available choice values for SELECT and RADIO custom fields. Null for other field types. |
options[] | string | Each item | |
required | boolean | Optional | Whether the custom field is required. |
type | string | Required within parent | The data type of the custom field. Known values: TEXT, DATE, NUMBER, CURRENCY, PERCENTAGE, SELECT, FILE, ID, RADIO, TEXTAREA, RANGE, REFERENCE_ID, BOOLEAN, ADDRESS, OG_REFERENCE_FIELD, NATIVE_EDGE, DATETIME, EMAIL, URL |
updated_at | string | Required within parent | Record update date |
List custom object fields — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
api_name | string | Required within parent | The api name of the custom object field |
created_at | string | Required within parent | Record creation date |
custom_object | string | Required within parent | The custom object which the field belongs to |
data_type | object | Required within parent | The data type configuration for the field. Additional keys: allowed |
data_type.num_of_decimal_places | JSON | Optional | |
data_type.num_of_decimal_places (anyOf 1) | integer | Alternative | Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields. Availability above the legacy per-type limit is capability-gated. Maximum: 15 Minimum: 0 |
data_type.num_of_decimal_places (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
description | string | Optional | The description of the custom object field |
enable_history | boolean | Required within parent | whether the history is enable for the field |
id | string | Required within parent | Identifier field |
is_immutable | boolean | Required within parent | whether the field is imuatable |
is_standard | boolean | Required within parent | whether the field is standard field |
is_unique | boolean | Required within parent | This field specifies whether a particular column value has unique values |
managed_package_install_id | string | Optional | The id of the package which the custom object field belongs to |
name | string | Required within parent | The name of the custom object field |
updated_at | string | Required within parent | Record update date |
List custom object list views — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A saved Custom Object grid configuration for selecting, filtering, and ordering records. |
api_name | string | Required within parent | Stable API name used to address this view. |
capabilities | Model | Required within parent | Expand Create a custom object list view — response body — capabilities |
columns | array | Required within parent | Visible columns, in saved display order. |
columns[] | Model | Each item | Expand Create a custom object list view — response body — columns item |
created_at | string | Required within parent | Time the view was created, as an ISO 8601 timestamp in UTC. Format: date-time |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Creator-provided explanation of the records or purpose of this saved view. Null when no explanation was saved. |
description (anyOf 2) | null | Alternative | |
has_filter | boolean | Required within parent | Whether this view applies a saved filter in addition to record_scope. The server resolves it when view_api_name is supplied to record queries. |
id | string | Required within parent | Read-only internal identifier; address operations using api_name. |
is_default | boolean | Required within parent | Whether this is the company's default view for this object. |
name | string | Required within parent | Display name of the saved view. |
order_by | JSON | Optional | |
order_by (anyOf 1) | string | Alternative | Saved ordering as one field API name, a space, and lowercase asc or desc, for example name asc. Null means no saved ordering. |
order_by (anyOf 2) | null | Alternative | |
record_scope | string | Required within parent | MY_RECORDS restricts owners to the authenticated requester when the view is used. Known values: ALL, MY_RECORDS |
updated_at | string | Required within parent | Time the view was last updated, as an ISO 8601 timestamp in UTC. Format: date-time |
visibility | string | Required within parent | PRIVATE belongs to its creator; SHARED is visible within the company. Neither grants record access. Known values: PRIVATE, SHARED |
Referenced models: Create a custom object list view — response body — columns item, Create a custom object list view — response body — capabilities
List custom objects — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
api_name | string | Optional | The api name of the custom object |
category_id | string | Required within parent | The category of the custom object |
created_at | string | Required within parent | Record creation date |
description | string | Optional | The description of the custom object |
enable_history | boolean | Required within parent | Whether to record the history of the custom object |
id | string | Required within parent | Identifier field |
managed_package_install_id | string | Optional | The id of the package which the custom object belongs to |
name | string | Required within parent | The name of the custom object |
native_category_id | string | Optional | The native category of the custom object if belongs to |
owner_id | string | Optional | The id of the owner for the custom object |
plural_label | string | Required within parent | The plural label of the custom object |
updated_at | string | Required within parent | Record update date |
List developer program application — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Developer Program application resource for Path B existing-company apply. |
build_description | string | Optional | What the company plans to build on Rippling |
company_id | string | Optional | Rippling company ID on the application |
email | string | Optional | Applicant email on the application |
expires_at | string | Optional | Time after which ops can no longer approve this pending application |
id | string | Required within parent | Stable application ID |
role_id | string | Optional | Applicant role ID |
signup_id | string | Optional | Deprecated alias of id. Prefer id. |
stages | Model | Optional | Expand Create a new developer program application — response body — stages |
status | string | Optional | Application status: EMAIL_VERIFICATION_PENDING, SUBMITTED, APPROVED, VERIFIED, REJECTED, or EXPIRED. Existing-company apply writes SUBMITTED and never EMAIL_VERIFICATION_PENDING. VERIFIED means provision finished, not email verified. Known values: EMAIL_VERIFICATION_PENDING, SUBMITTED, APPROVED, VERIFIED, REJECTED, EXPIRED |
submitted_at | string | Optional | Time the application was submitted |
Referenced models: Create a new developer program application — response body — stages
List device orders — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cancel_requested | boolean | Optional | True when a cancellation has been requested but not yet completed. |
completed_at | string | Optional | When the order reached a terminal state (COMPLETED, FAILED, or CANCELED). |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
order_type | string | Optional | The type of hardware order, as reported by the underlying inventory order (for example: New Device Order, Warehouse Return, Warehouse Order, Add Existing Device, Assign Device, Empty Order, or Sell Device). |
requested_by_id | string | Optional | The ID of the role that requested the order (often an IT admin). Null if system-created. |
status | string | Optional | The order lifecycle state (InventoryFlowState): CREATED, RUNNING, COMPLETED, FAILED, CANCELING, CANCELED. |
updated_at | string | Required within parent | Record update date |
warehouse_provider | string | Optional | The warehouse / vendor provider servicing the order (e.g. CDW, INGRAMMICRO, TD_SYNNEX, GROWRK). |
worker | Model | Optional | Expand Retrieve a specific device order — response body — worker |
worker_id | string | Optional | The ID of the worker the order is for (the recipient). Null if unassigned. |
Referenced models: Retrieve a specific device order — response body — worker
List devices — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
enrollment_status | string | Optional | The MDM enrollment status: ENROLLED, UNENROLLED, WAITING_FOR_CONNECTION, ERROR, etc. Known values: ENROLLED, WAITING_FOR_CONNECTION, ERROR, UNENROLLED |
id | string | Required within parent | Identifier field |
is_encrypted | boolean | Optional | Whether the device's disk is encrypted (FileVault on macOS, BitLocker on Windows). |
is_managed | boolean | Optional | Whether the device is managed via MDM. |
last_checkin_at | string | Optional | When the Rippling agent last checked in from this device. |
last_mdm_sync_at | string | Optional | When the device last synced with MDM. |
lifecycle_state | string | Optional | The device lifecycle state (e.g. ACTIVE, READY, LOCKED, LOST, DECOMMISSIONED). Known values: INIT, ACTIVE, ACTIVATING, LOCKED, LOCKING, INACTIVE, PENDING_MDM, CLEANING, READY, DECOMMISSIONING, DECOMMISSIONED, FULL_WIPING, FULL_WIPED, E_CYCLED, SOLD, MDM_LOCKED, LOST, LOST_PLAYING_SOUND |
mdm_provider | string | Optional | The MDM provider currently recorded on the device (RIPPLING, JAMFCLOUD, INTUNE, KANDJI, etc.). Null when the device is not currently MDM-managed (typical for unenrolled or recently-reset devices). Known values: RIPPLING, JUMPCLOUD, JAMFCLOUD, FLEETSMITH, HEXNODE, MICROMDM, MERAKI, SOTI, ADDIGY, FLEETDM, KANDJI, ZOHO, INTUNE, OTHER |
model | string | Optional | The device hardware model identifier as reported by MDM (e.g. 'MacBookPro18,3', 'iPhone15,2'). |
os_name | string | Optional | The device operating system name. |
os_version | string | Optional | The device operating system version. |
pending_actions | array | Optional | Actions currently queued against the device (not yet completed). Expandable. Expandable field |
pending_actions[] | Model | Each item | Expand Retrieve a specific device — response body — pending actions item |
pending_actions_id | array | Optional | The IDs of actions currently queued against the device (not yet completed). |
pending_actions_id[] | string | Each item | |
platform | string | Optional | The OS platform the device runs: MACOS, WINDOWS, IOS, or IPADOS. Known values: MACOS, WINDOWS, IOS, IPADOS |
serial_number | string | Optional | The device's hardware serial number. |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Retrieve a specific device — response body — worker |
worker_id | string | Optional | The ID of the worker this device is currently assigned to. Null if unassigned. |
Referenced models: Retrieve a specific device — response body — pending actions item, Retrieve a specific device — response body — worker
List earning-types — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An earning category available in Global Payroll, such as salary, commission, or bonus. |
country_code | string | Optional | Uppercase ISO 3166-1 alpha-2 country code of the payroll catalog, such as `CA` or `US`. |
display_name | string | Optional | Configured display name of the earning type. Entries with different configurations can have the same name and `earning_code`. |
earning_code | string | Optional | Code used to select this earning type in `POST /earnings-inputs/`, such as `regular_salary` or `commission`. Availability is validated against the worker's payroll catalog. |
id | string | Optional | Identifier of a source earning type. With `company_entity_id`, equivalent entries use one existing ID, which can change when its source entry is removed. Use `earning_code` when submitting payroll earnings inputs. |
List earnings-inputs — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | V2 DTO representing an external earnings input record. Used by: - GET /earnings-inputs/ (list) |
amount | string | Optional | Earning amount as a string-encoded decimal. |
assignment_type | string | Optional | How the earning is assigned (e.g. BY_PAY_PERIOD). |
company_entity_id | string | Optional | Identifier for the legal entity (company entity relationship) this earning is associated with. Use this to correlate earnings with a specific legal entity in a multi-entity company. |
earning_code | string | Optional | Code identifying the earning type (e.g. regular_salary). |
earning_end_date | string | Optional | End of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run. |
earning_start_date | string | Optional | Start of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run. |
external_id | string | Optional | External reference identifier for this earning. |
hours | string | Optional | Hours associated with this earning as a string-encoded decimal. |
id | string | Optional | Unique identifier for the earnings input. |
is_overridden | boolean | Optional | Whether this earning's amount was manually overridden instead of using the calculated value. Always false for newly created earnings. |
pay_period_basis_date | string | Optional | The pay period basis date for this earning. |
run_id | string | Optional | Identifier of the payroll run this earning is assigned to, if any. |
status | string | Optional | Current status of the earnings input (e.g. UNASSIGNED, ASSIGNED). |
time_labels | array | Optional | Time tracking labels associated with this earning. |
time_labels[] | string | Each item | |
worker_id | string | Optional | Identifier of the worker (role ID). |
List employment types — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount_worked | string | Optional | The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually. Known values: PART-TIME, FULL-TIME, TEMPORARY |
compensation_time_period | string | Optional | The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked. Known values: HOURLY, SALARIED |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
label | string | Required within parent | The display label of the employment type. |
name | string | Optional | The name of the employment type for non-custom employment types. |
type | string | Optional | The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights. Known values: CONTRACTOR, EMPLOYEE |
updated_at | string | Required within parent | Record update date |
List entitlements — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Description of the entitlement |
display_name | string | Required within parent | Display name of the entitlement |
id | string | Required within parent | Identifier field |
List files in the active bundle — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bundle_id | string | Optional | Active bundle identifier. |
directories | array | Optional | Directories in the listing scope. |
directories[] | Model | Each item | Expand List files in the active bundle — response body — directories item |
entry_path | string | Optional | Entry path for the active bundle. |
files | array | Optional | Files in the listing scope. |
files[] | Model | Each item | Expand List files in the active bundle — response body — files item |
parent_path | string | Optional | Directory path used for the listing. |
recursive | boolean | Optional | Whether the listing was recursive. |
Referenced models: List files in the active bundle — response body — directories item, List files in the active bundle — response body — files item
List files in the active bundle — response body — directories item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | Directory name. |
parent_path | string | Optional | Parent directory path. |
path | string | Optional | Normalized directory path inside the active bundle. |
List files in the active bundle — response body — files item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
content_type | string | Optional | MIME content type. |
name | string | Optional | File name. |
parent_path | string | Optional | Parent directory path. |
path | string | Optional | Normalized file path inside the active bundle. |
sha256 | string | Optional | SHA-256 hash of the file contents. |
size_bytes | JSON | Optional | |
size_bytes (anyOf 1) | integer | Alternative | File size in bytes. |
size_bytes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List finance categories — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Finance 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 Finance category. |
updated_at | string | Required within parent | Record update date |
List finance vendors — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A vendor in the company's Finance 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 Finance vendor. Name eq, ne, and in filters also match alternate names. |
updated_at | string | Required within parent | Record update date |
List function deployments — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_domains | array | Optional | Domains that function runs from this deployment are allowed to access |
allowed_domains[] | string | Each item | |
code | string | Optional | The code for the deployment |
created_at | string | Required within parent | The creation date of the deployment |
dependencies | object | Optional | The dependencies of the deployment |
external_id | string | Optional | The external ID of the deployment |
function_api_name | string | Optional | The API name of the function that this deployment is associated with |
function_id | string | Optional | The ID of the function that this deployment is associated with |
function_version_human_friendly_id | JSON | Optional | |
function_version_human_friendly_id (anyOf 1) | integer | Alternative | The human friendly ID of version that this deployment is associated with |
function_version_human_friendly_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
function_version_id | string | Optional | The ID of the version that this deployment is associated with |
id | string | Required within parent | The ID of the deployment |
io_contract | object | Optional | Input and output JSON Schema contracts for the deployment |
options | object | Optional | Additional, runtime-specific options for the deployment |
runtime | string | Optional | The runtime for the deployment |
status | string | Optional | The status of the deployment |
updated_at | string | Required within parent | The last updated date of the deployment |
List function execution logs — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
level | string | Optional | The log level |
message | string | Required within parent | The log message |
params | object | Optional | Parameters associated with the log line |
sequence_num | JSON | Required within parent | |
sequence_num (anyOf 1) | integer | Alternative | The sequence number of the log line |
sequence_num (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timestamp | string | Optional | The log timestamp |
List function executions — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
finished_at | string | Optional | The end time of the execution |
function_id | string | Required within parent | The ID of the function this execution belongs to |
id | string | Required within parent | Identifier field |
inputs | object | Required within parent | The inputs of the execution |
outputs | object | Optional | The outputs of the execution |
started_at | string | Optional | The start time of the execution |
status | string | Optional | The status of the execution |
updated_at | string | Required within parent | Record update date |
List functions — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
api_name | string | Optional | The API name of the function |
code_draft | string | Optional | The current draft of code for the function |
created_at | string | Required within parent | Record creation date |
dependencies | object | Optional | The dependencies of the function |
description | string | Optional | The function description |
id | string | Required within parent | Identifier field |
is_async | boolean | Optional | Whether this function runs asynchronously |
listed_in_custom_apps | boolean | Optional | Whether this request-function is listed in the Custom Apps grid and navigation. Defaults to false on creation; omitted updates preserve the current value. Listing does not grant access or change deployment behavior. Only supported for request functions. Setting this field on an event function returns a validation error. |
name | string | Optional | The function name |
source_upload_instructions | Model | Optional | Expand Update a function — response body — source upload instructions |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a function — response body — source upload instructions
List headcount positions — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actual_compensation | Model | Optional | Expand Retrieve a specific headcount position — response body — actual compensation |
backfill_for | Model | Optional | Expand Retrieve a specific headcount position — response body — backfill for |
backfill_for_id | string | Optional | ID of the worker for whom this headcount position was requested as a backfill |
comp_band_compensation | Model | Optional | Expand Retrieve a specific headcount position — response body — comp band compensation |
created_at | string | Required within parent | Record creation date |
current_start_date | string | Optional | Most recent start date estimate or the actual hire date if already filled |
department | Model | Optional | Expand Retrieve a specific headcount position — response body — department |
department_id | string | Optional | ID for the department the headcount belongs to |
employment_type | Model | Optional | Expand Retrieve a specific headcount position — response body — employment type |
employment_type_id | string | Optional | ID for the employment type the headcount is assigned to |
end_date | string | Optional | Targeted end date for the headcount |
headcount_owner | Model | Optional | Expand Retrieve a specific headcount position — response body — headcount owner |
headcount_owner_id | string | Optional | ID for the headcount owner |
id | string | Required within parent | Identifier field |
in_budget | boolean | Optional | Whether the headcount position is in budget |
job_function | object | Optional | Job function assigned to this headcount 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 for the job function the headcount is assigned to |
job_requisition | Model | Optional | Expand Retrieve a specific headcount position — response body — job requisition |
job_requisition_id | string | Optional | ID for the job requisition the headcount is associated with |
level | Model | Optional | Expand Retrieve a specific headcount position — response body — level |
level_id | string | Optional | ID for the level the headcount is assigned to |
location_factor | Model | Optional | Expand Retrieve a specific headcount position — response body — location factor |
location_factor_id | string | Optional | ID for the location factor the headcount is assigned to |
notes | string | Optional | Headcount notes |
position_id | string | Optional | Position name for the headcount, for ex PID100037 |
position_sub_type | string | Optional | More granular classification of headcount position type. `NEW` New headcount created, typically paired with the OPEN_HEADCOUNT type. `BACKFILL` Replacement headcount for someone who left the company. `FORECASTED_ATTRITION` Headcount that does not count toward the budget, also known as provisional position in the application, `HIRING_STAGE` Person is going through the hiring process, paired with the FUTURE_START type. `OFFER_STAGE` Offer has been extended to a candidate, awaiting their decision. Paired with the FUTURE_START type. `OFFER_ACCEPTED` Candidate has accepted the offer but has not yet started. Paired with the FUTURE_START type. `PLAN_CHANGE` Headcount status changed due to business decision. Paired with CLOSED type. `TERMINATED` Role was filled, but the employee was separated from the company. Paired with CLOSED type. `TRANSFERRED` Employee moved internally to another role. Paired with CLOSED type. Known values: NEW, BACKFILL, FORECASTED_ATTRITION, HIRING_STAGE, OFFER_STAGE, OFFER_ACCEPTED, PLAN_CHANGE, TERMINATED, TRANSFERRED |
position_type | string | Optional | Type of headcount position. `OPEN_HEADCOUNT` A headcount position that's not yet filled. `FUTURE_START` Headcount where a candidate is going through the hiring process, or an offer has been accepted, but the person has not yet started. `ACTIVE` Headcount where a candidate has been hired and started. `CLOSED` Headcount that's no longer available to fill. Known values: OPEN_HEADCOUNT, FUTURE_START, ACTIVE, CLOSED |
priority | object | Optional | Priority assigned to this headcount Expandable field |
priority.created_at | string | Required within parent | Record creation date |
priority.id | string | Required within parent | Identifier field |
priority.name | string | Optional | Display name of the headcount priority |
priority.updated_at | string | Required within parent | Record update date |
priority_id | string | Optional | ID for the headcount priority |
recruiter | Model | Optional | Expand Retrieve a specific headcount position — response body — recruiter |
recruiter_id | string | Optional | ID for the recruiter working on filling the position |
target_start_date | string | Optional | The estimated start date when the position was first created |
teams | array | Optional | Teams the headcount belongs to Expandable field |
teams[] | Model | Each item | Expand Update a team — response body — parent |
teams_id | array | Optional | IDs for the teams the headcount belongs to |
teams_id[] | string | Each item | |
title | string | Optional | Job title for the position. For a vacant headcount position, this can be defined on creation. Once the position is occupied, it’s synched from the associated worker’s job title. |
updated_at | string | Required within parent | Record update date |
work_location | Model | Optional | Expand Retrieve a specific headcount position — response body — work location |
work_location_id | string | Optional | ID for the work location the headcount is assigned to |
worker | Model | Optional | Expand Retrieve a specific headcount position — response body — worker |
worker_id | string | Optional | ID for the worker hired into the headcount |
Referenced models: Update a team — response body — parent, Retrieve a specific headcount position — response body — actual compensation, Retrieve a specific headcount position — response body — backfill for, Retrieve a specific headcount position — response body — comp band compensation, Retrieve a specific headcount position — response body — department, Retrieve a specific headcount position — response body — employment type, Retrieve a specific headcount position — response body — headcount owner, Retrieve a specific headcount position — response body — job requisition, Retrieve a specific headcount position — response body — level, Retrieve a specific headcount position — response body — location factor, Retrieve a specific headcount position — response body — recruiter, Retrieve a specific headcount position — response body — work location, Retrieve a specific headcount position — response body — worker
List headcount priorities — 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 | Display name of the headcount priority |
updated_at | string | Required within parent | Record update date |