Skip to content

Deel: Retrieve a list of ATS job postings

Deel atsJobPostings.retrieveAlistOfAtsJobPostings: arguments, response, policy and SDK examples.

← ATS job postings operations · Get started

Operation deel.atsjobpostings_retrievealistofatsjobpostings

Provider route: GET /ats/job-boards/{job_board_id}/job-postings. 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["atsJobPostings"]["retrieveAlistOfAtsJobPostings"]>[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.atsJobPostings.retrieveAlistOfAtsJobPostings(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_job_postings.retrieve_alist_of_ats_job_postings(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.job_board_idstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.cursorstringOptional
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve ATS job postings — 200 response body

Referenced models: Retrieve ATS job postings — 200 response body

8 more schemas are linked from the tables above, on the schema pages.

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

Referenced models: Retrieve ATS job posting — 200 response body — data

Retrieve ATS job posting — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRootJob posting with nested job details and publication status.
application_formJSONOptionalApplication form assigned to the job posting
application_form (anyOf 1)ModelAlternativeExpand Retrieve ATS job posting — 200 response body — data application form Application form assigned to the job posting
application_form (anyOf 2)nullAlternative
created_atstringRequired within parentCreation timestamp
Format: date-time
idstringRequired within parentUnique identifier for the job posting
Format: uuid
is_compensation_visiblebooleanRequired within parentIndicates if compensation details are visible to candidates
jobModelRequired within parentExpand Retrieve ATS job posting — 200 response body — data job
Associated job information
job_idstringRequired within parentIdentifier of the underlying job this posting belongs to.
Format: uuid
publicationsarrayRequired within parentPublication rows for this posting, one per job board integration, with current state.
publications[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data publications item
richtext_descriptionJSONRequired within parent
richtext_description (anyOf 1)stringAlternativeRich text description of the job posting
richtext_description (anyOf 2)nullAlternativeRich text description of the job posting
titlestringRequired within parentJob posting title
Maximum length: 200
updated_atstringRequired within parentLast update timestamp
Format: date-time

Referenced models: Retrieve ATS job posting — 200 response body — data application form Application form assigned to the job posting, Retrieve ATS job posting — 200 response body — data job, Retrieve ATS job posting — 200 response body — data publications item

Retrieve ATS job posting — 200 response body — data application form Application form assigned to the job posting
FieldTypePresenceDescription and constraints
$objectRootApplication form assigned to the job posting
idstringRequired within parentUnique identifier for the application form
Format: uuid
titlestringRequired within parentTitle of the application form
Retrieve ATS job posting — 200 response body — data job
FieldTypePresenceDescription and constraints
$objectRootAssociated job information
compensationJSONRequired within parentCompensation information for the job
compensation (anyOf 1)ModelAlternativeExpand Retrieve ATS job posting — 200 response body — data job compensation Compensation information for the job
compensation (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the job
Format: uuid
job_departmentsJSONOptional
job_departments (anyOf 1)arrayAlternativeDepartments associated with the job
job_departments (anyOf 1)[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item
job_departments (anyOf 2)nullAlternativeDepartments associated with the job
job_departments (anyOf 2)[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item
job_employment_typesarrayRequired within parentEmployment types associated with the job
job_employment_types[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data job job employment types item
job_locationsarrayRequired within parentLocations associated with the job
job_locations[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data job job locations item
job_teamsJSONOptional
job_teams (anyOf 1)arrayAlternativeTeams associated with the job
job_teams (anyOf 1)[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item
job_teams (anyOf 2)nullAlternativeTeams associated with the job
job_teams (anyOf 2)[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item

Referenced models: Retrieve ATS job posting — 200 response body — data job job employment types item, Retrieve ATS job posting — 200 response body — data job job locations item, Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item, Retrieve ATS job posting — 200 response body — data job compensation Compensation information for the job, Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item

Retrieve ATS job posting — 200 response body — data publications item
FieldTypePresenceDescription and constraints
$objectRootPublication information for different job boards
current_stateModelRequired within parentExpand Retrieve ATS job posting — 200 response body — data publications item current state
Current publication state details
idstringRequired within parentUnique identifier for the job posting publication
Format: uuid
job_boardModelRequired within parentExpand Retrieve ATS job posting — 200 response body — data publications item job board
Job board where the posting is published

Referenced models: Retrieve ATS job posting — 200 response body — data publications item job board, Retrieve ATS job posting — 200 response body — data publications item current state

Retrieve ATS job posting — 200 response body — data job job employment types item
FieldTypePresenceDescription and constraints
$objectRoot
employment_typeModelRequired within parentExpand Retrieve ATS job posting — 200 response body — data job job employment types item employment type
Details for the employment type assigned to the job
idstringRequired within parentUnique identifier for the job employment type
Format: uuid

Referenced models: Retrieve ATS job posting — 200 response body — data job job employment types item employment type

Retrieve ATS job posting — 200 response body — data job job locations item
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the job location
Format: uuid
locationModelRequired within parentExpand Retrieve ATS job posting — 200 response body — data job job locations item location
Details for the location assigned to the job

Referenced models: Retrieve ATS job posting — 200 response body — data job job locations item location

Retrieve ATS job posting — 200 response body — data publications item job board
FieldTypePresenceDescription and constraints
$objectRootJob board where the posting is published
idstringRequired within parentUnique identifier for the job board
Format: uuid

SDK function policy ID: deel.atsjobpostings_retrievealistofatsjobpostings. Catalog operation: atsjobpostings_retrievealistofatsjobpostings. 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.