Skip to content

Rippling: List job assignments

Rippling restApi.listJobAssignments: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.list_job_assignments

Provider route: GET /job-assignments/. Alter supplies the connection’s credentials and routing.

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"]["listJobAssignments"]>[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.listJobAssignments(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_job_assignments(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.filterstringOptional
query.expandstringOptional
query.order_bystringOptional
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRoot
__metaModelOptionalExpand List Sites — response body — meta
next_linkstringOptionalA link to the next page of responses.
Format: uri
resultsarrayOptional
results[]ModelEach itemExpand List job assignments — response body — results item

Referenced models: List job assignments — response body — results item, List Sites — response body — meta

33 more schemas are linked from the tables above, on the schema pages.

List job assignments — response body — results item
FieldTypePresenceDescription and constraints
$objectRoot
base_pay_rateJSONOptional
base_pay_rate (anyOf 1)numberAlternativeBase compensation rate of worker
base_pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
job_codeModelOptionalExpand Update a job assignment — response body — job code
job_code_idstringRequired within parentIdentifier of job that is assigned to worker
job_pay_rateJSONOptional
job_pay_rate (anyOf 1)numberAlternativeThe pay rate for job assigned to worker. This can be different from the job's standard pay rate and can be overriden for a worker.
job_pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
job_pay_rate_exceptionsarrayOptionalPay rate exceptions applicable for the worker based on certain exception dimension values.

Expandable field
job_pay_rate_exceptions[]ModelEach itemExpand List job pay rate exceptions — response body — results item
job_pay_rate_exceptions_idarrayOptionalIdentifier of pay rate exceptions applicable for the worker based on certain exception dimension values.
job_pay_rate_exceptions_id[]stringEach item
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Update a job assignment — response body — worker
worker_idstringRequired within parentIdentifier of worker to whom job is assigned.

Referenced models: List job pay rate exceptions — response body — results item, Update a job assignment — response body — job code, Update a job assignment — response body — worker

List Sites — response body — meta
FieldTypePresenceDescription and constraints
$objectRootA list of redacted fields.
redacted_fieldsarrayOptional
redacted_fields[]objectEach item
redacted_fields[].namestringOptionalThe name for the redacted field
redacted_fields[].reasonstringOptionalThe reason for the redaction
List job pay rate exceptions — response body — results item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
exception_dimension_idstringRequired within parentIdentifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource
exception_dimension_typestringOptionalType of dimension on which exception is configured
Known values: JOB_CODE, LEVEL, TEAM, DEPARTMENT, WORK_LOCATION
idstringRequired within parentIdentifier field
job_codeModelOptionalExpand Retrieve a specific job pay rate exception — response body — job code
job_code_idstringRequired within parentIdentifier of Job for which exception is configured.
pay_rateJSONRequired within parent
pay_rate (anyOf 1)numberAlternativeThe pay rate for exception on job_code_id and exception_dimension_id combination
pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentRecord update date

Referenced models: Retrieve a specific job pay rate exception — response body — job code

Update a job assignment — response body — job code
FieldTypePresenceDescription and constraints
$objectRootJob that is assigned to worker

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

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

Referenced models: Update a job code — response body — pay rate exceptions item, Update a job code — response body — custom location, Update a job code — response body — department, Update a job code — response body — job dimension, Update a job code — response body — work location

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

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

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

Update a job code — response body — custom location
FieldTypePresenceDescription and constraints
$objectRootThe custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.
addressModelRequired within parentExpand Update a job code — response body — custom location address

Referenced models: Update a job code — response body — custom location address

Update a job code — response body — work location
FieldTypePresenceDescription and constraints
$objectRootThe work location associated with the job code.

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

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

SDK function policy ID: rippling.rest_api.list_job_assignments. Catalog operation: list-job-assignments. 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: ["job-assignments.read"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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