Rippling: Get Jobs

← recruiting_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.recruiting_api.get_external_job

Provider route: GET /external/job. 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["recruitingApi"]["getExternalJob"]>[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.recruitingApi.getExternalJob(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.recruiting_api.get_external_job(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.createdAfter	string	Optional
query.offset	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
Total Count	JSON	Optional
Total Count (anyOf 1)	integer	Alternative
Total Count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
jobs	array	Optional
jobs[]	object	Each item
jobs[].createdAt	string	Optional
jobs[].id	string	Optional
jobs[].name	string	Optional
jobs[].requisitionId	string	Optional	Human-friendly ‘id’ to represent the job.
jobs[].stages	array	Optional
jobs[].stages[]	object	Each item
jobs[].stages[].id	string	Optional
jobs[].stages[].name	string	Optional
jobs[].status	string	Optional	Known values: PUBLISHED, OPEN
offset	string or null	Optional
perChunk	JSON	Optional
perChunk (anyOf 1)	integer	Alternative
perChunk (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: rippling.recruiting_api.get_external_job. Catalog operation: recruiting-api.get-external-job. 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.

Official provider source