Rippling: Retrieve a specific job code

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.get_job_codes

Provider route: GET /job-codes/{id}/. Alter supplies the connection’s credentials and routing.

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"]["getJobCodes"]>[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.getJobCodes(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.get_job_codes(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Format: id
query	object	Optional	Additional keys: not allowed
query.expand	string	Optional

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	object	Optional
__meta.redacted_fields	array	Optional
__meta.redacted_fields[]	Model	Each item	Expand Retrieve a report run — response body — meta redacted fields item
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, Retrieve a report run — response body — meta redacted fields 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

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.get_job_codes. Catalog operation: get-job-codes. 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-codes.read"]

Provider entitlements: ["API_Tier_1"]

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

Official provider source