Skip to content

Rippling: Locations

Rippling jobBoardApiV2.getBoardSlugLocations: arguments, response, policy and SDK examples.

← Job board API v2 operations · Get started

Operation rippling.job_board_api_v2.get_board_slug_locations

Provider route: GET /{board_slug}/locations. 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["jobBoardApiV2"]["getBoardSlugLocations"]>[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.getBoardSlugLocations(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_locations(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.board_slugstringRequired within parent

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

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayOptional
items[]ModelEach itemExpand Locations — response body — items item
pageJSONOptional
page (anyOf 1)integerAlternative
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSizeJSONOptional
pageSize (anyOf 1)integerAlternative
pageSize (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalItemsJSONOptional
totalItems (anyOf 1)integerAlternative
totalItems (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Locations — response body — items item

Locations — response body — items item
FieldTypePresenceDescription and constraints
$objectRoot
cityJSONOptional
city (anyOf 1)stringAlternativeFull city name
city (anyOf 2)nullAlternative
countrystringOptionalCountry name
countryCodeJSONOptional
countryCode (anyOf 1)stringAlternativeCountry code
countryCode (anyOf 2)nullAlternative
namestringRequired within parentDisplay name
stateJSONOptional
state (anyOf 1)stringAlternativeState name
state (anyOf 2)nullAlternative
stateCodeJSONOptional
stateCode (anyOf 1)stringAlternativeState code
stateCode (anyOf 2)nullAlternative
workplaceTypestringOptionalKnown values: ON_SITE, REMOTE, HYBRID

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

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.