Rippling: List worker time splits
Rippling restApi.listWorkerTimeSplits: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.list_worker_time_splits
Provider route: GET /worker-time-splits/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["listWorkerTimeSplits"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.restApi.listWorkerTimeSplits(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_rippling import RipplingIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.rest_api.list_worker_time_splits(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.filter | string | Optional | |
query.expand | string | Optional | |
query.order_by | string | Optional | |
query.limit | integer | Optional | Default: 50 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
__meta | Model | Optional | Expand List Sites — response body — meta |
next_link | string | Optional | A link to the next page of responses. Format: uri |
results | array | Optional | |
results[] | Model | Each item | Expand List worker time splits — response body — results item |
Referenced models: List Sites — response body — meta, List worker time splits — response body — results item
Schemas
Section titled “Schemas”30 more schemas are linked from the tables above, on the schema pages.
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 worker time splits — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker time split configuration resource. |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_enabled | boolean | Optional | Whether hard-coded time splits are active for this worker. |
job_codes | array | Optional | The job codes referenced in this time split configuration. Use ?expand=job_codes to populate. Expandable field |
job_codes[] | Model | Each item | Expand List job codes — response body — results item |
job_codes_id | array | Optional | IDs of all unique job codes referenced across all split rows. |
job_codes_id[] | string | Each item | |
splits | array | Optional | The split rows defining time allocation percentages across job codes. Empty when is_enabled is false. |
splits[] | Model | Each item | Expand Update a worker time split — response body — splits item |
updated_at | string | Required within parent | Record update date |
worker | Model | Optional | Expand Update a worker time split — response body — worker |
worker_id | string | Required within parent | Identifier of the worker whose time split configuration this represents. |
Referenced models: List job codes — response body — results item, Update a worker time split — response body — splits item, Update a worker time split — response body — worker
List job codes — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
custom_location | Model | Optional | Expand Update a job code — response body — custom location |
department | Model | Optional | Expand Update a job code — response body — department |
department_id | string | Optional | The department associated with the job code. |
external_id | string | Optional | The unique identifier of the job code in an outside system. |
group_id | string | Optional | The ID of the job roster group. |
id | string | Required within parent | Identifier field |
is_archived | boolean | Optional | Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API. |
job_dimension | Model | Optional | Expand Update a job code — response body — job dimension |
job_dimension_id | string | Required within parent | The ID of the job dimension this job code belongs to. |
name | string | Required within parent | The name of the job dimension. |
pay_rate | JSON | Optional | |
pay_rate (anyOf 1) | number | Alternative | The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute. |
pay_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pay_rate_exceptions | array | Optional | Pay rate overrides for the job based on exception dimension values. Expandable field |
pay_rate_exceptions[] | Model | Each item | Expand Update a job code — response body — pay rate exceptions item |
pay_rate_exceptions_id | array | Optional | Pay rate overrides id for the job based on exception dimension values. |
pay_rate_exceptions_id[] | string | Each item | |
updated_at | string | Required within parent | Record update date |
work_location | Model | Optional | Expand Update a job code — response body — work location |
work_location_id | string | Optional | The work location associated with the job code. |
Referenced models: Update a job code — response body — pay rate exceptions item, Update a job code — response body — custom location, Update a job code — response body — department, Update a job code — response body — job dimension, Update a job code — response body — work location
Update a worker time split — response body — splits item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single split row representing a percentage allocation across one or more job codes. |
job_code_ids | array | Optional | IDs of canonical /job-codes/ resources in this split row. |
job_code_ids[] | string | Each item | |
split_percentage | string | Optional | Percentage allocated to this split row. Decimal string with precision 2; must be greater than zero per row. All rows must sum to 100.00 when is_enabled is true. |
Update a job code — response body — pay rate exceptions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
exception_dimension_id | string | Required within parent | Identifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource |
exception_dimension_type | string | Optional | Type of dimension on which exception is configured Known values: JOB_CODE, LEVEL, TEAM, DEPARTMENT, WORK_LOCATION |
id | string | Required within parent | Identifier field |
job_code | Model | Optional | Expand List job codes — response body — results item Job for which exception is configured. Expandable field |
job_code_id | string | Required within parent | Identifier of Job for which exception is configured. |
pay_rate | JSON | Required within parent | |
pay_rate (anyOf 1) | number | Alternative | The pay rate for exception on job_code_id and exception_dimension_id combination |
pay_rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Record update date |
Referenced models: List job codes — response body — results item
Update a job code — response body — custom location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code. |
address | Model | Required within parent | Expand Update a job code — response body — custom location address |
Referenced models: Update a job code — response body — custom location address
Update a job code — response body — department
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The department associated with the job code. Expandable field |
created_at | string | Required within parent | Record creation date |
department_hierarchy | array | Optional | List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order. Expandable field |
department_hierarchy[] | Model | Each item | Expand Update a department — response body — parent |
department_hierarchy_id | array | Optional | The identifier of departments in the department hierarchy ordered from parent department to child department. |
department_hierarchy_id[] | string | Each item | |
id | string | Required within parent | Identifier field |
name | string | Required within parent | The name of the department. |
parent | Model | Optional | Expand Update a department — response body — parent The parent department. Expandable field |
parent_id | string | Optional | The parent department. |
reference_code | string | Optional | Reference code of the department. |
updated_at | string | Required within parent | Record update date |
Referenced models: Update a department — response body — parent
Retrieve a specific worker — response body — work schedule value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The scheduled working hours for a day of the week. |
hours | JSON | Optional | |
hours (anyOf 1) | number | Alternative | The number of scheduled working hours for the day. |
hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.list_worker_time_splits. Catalog operation: list-worker-time-splits. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["worker-time-splits.read"]
Provider entitlements: ["API_Tier_1"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}