Rippling: Jobs

← job_board_api_v2 operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.job_board_api_v2.get_board_slug_jobs

Provider route: GET /{board_slug}/jobs. 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["jobBoardApiV2"]["getBoardSlugJobs"]>[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.jobBoardApiV2.getBoardSlugJobs(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.job_board_api_v2.get_board_slug_jobs(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.board_slug	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.country	string	Optional
query.state	string	Optional
query.city	string	Optional	Maximum length: 255
query.workplaceType	string	Optional	One of: ON_SITE, REMOTE, HYBRID
query.page	integer	Optional	Minimum: 0
query.pageSize	integer	Optional	Maximum: 1000 Minimum: 1
query.searchQuery	string	Optional	Maximum length: 255
query.departments	array	Optional
query.departments[]	string	Each item
query.groupJobsByLocation	boolean	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
items	array	Optional
items[]	object	Each item
items[].department	object	Optional
items[].department.name	string	Optional
items[].id	string	Optional
items[].locations	array	Optional
items[].locations[]	Model	Each item	Expand Jobs — response body — items item locations item
items[].url	string	Optional
page	JSON	Optional
page (anyOf 1)	integer	Alternative
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSize	JSON	Optional
pageSize (anyOf 1)	integer	Alternative
pageSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalItems	JSON	Optional
totalItems (anyOf 1)	integer	Alternative
totalItems (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalPages	JSON	Optional
totalPages (anyOf 1)	integer	Alternative
totalPages (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Jobs — response body — items item locations item

Policy, approvals and errors

SDK function policy ID: rippling.job_board_api_v2.get_board_slug_jobs. Catalog operation: job-board-api-v2.get-board_slug-jobs. 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