Skip to content

Deel: Retrieve a list of ATS locations

Deel atsLocations.retrieveAlistOfAtsLocations: arguments, response, policy and SDK examples.

← ATS locations operations · Get started

Operation deel.atslocations_retrievealistofatslocations_v2026_01_01

Provider route: GET /ats/locations. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["atsLocations"]["retrieveAlistOfAtsLocations"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.atsLocations.retrieveAlistOfAtsLocations(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.ats_locations.retrieve_alist_of_ats_locations(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.cursorstringOptional
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
query.include_archivedstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve a list of ATS locations — 200 response body

Referenced models: Retrieve a list of ATS locations — 200 response body

Retrieve a list of ATS locations — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of locations.
data[]ModelEach itemExpand Retrieve a list of ATS locations — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more locations available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for pagination to get the next set of results
next_cursor (anyOf 2)nullAlternativeCursor for pagination to get the next set of results
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of locations available
Minimum: 0
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a list of ATS locations — 200 response body — data item

Retrieve a list of ATS locations — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeTimestamp when the location was archived; null while the location is active and selectable
Format: date-time
archived_at (anyOf 2)nullAlternativeTimestamp when the location was archived; null while the location is active and selectable
Format: date-time
cityJSONOptional
city (anyOf 1)stringAlternativeCity name
city (anyOf 2)nullAlternativeCity name
country_codeJSONOptional
country_code (anyOf 1)stringAlternativeISO country code
country_code (anyOf 2)nullAlternativeISO country code
created_atstringRequired within parentTimestamp when the location was created
Format: date-time
idstringRequired within parentUnique identifier for the location
Format: uuid
is_remotebooleanOptionalIndicates if this is a remote location
location_groupJSONOptionalLocation group information
location_group (anyOf 1)ModelAlternativeExpand Retrieve a list of ATS locations — 200 response body — data item location group Location group information
location_group (anyOf 2)nullAlternative
namestringRequired within parentName of the location/country
province_or_region_textJSONOptional
province_or_region_text (anyOf 1)stringAlternativeProvince or region text
province_or_region_text (anyOf 2)nullAlternativeProvince or region text
updated_atstringRequired within parentTimestamp when the location was last updated
Format: date-time

Referenced models: Retrieve a list of ATS locations — 200 response body — data item location group Location group information

Retrieve a list of ATS locations — 200 response body — data item location group Location group information
FieldTypePresenceDescription and constraints
$objectRootLocation group information
idstringRequired within parentUnique identifier for the location group
Format: uuid
namestringRequired within parentName of the location group

SDK function policy ID: deel.atslocations_retrievealistofatslocations_v2026_01_01. Catalog operation: atslocations_retrievealistofatslocations_v2026_01_01. 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: ["ats:read", "worker:read"]

Pinned headers: {"X-Version": "2026-01-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.