Deel: Retrieve ATS job posting
Deel atsJobPostings.retrieveAtsJobPosting: arguments, response, policy and SDK examples.
← ATS job postings operations · Get started
Operation deel.atsjobpostings_retrieveatsjobposting
Provider route: GET /ats/job-postings/{job_posting_id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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"]["retrieveAtsJobPosting"]>[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.retrieveAtsJobPosting(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_ats_job_posting(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.job_posting_id | string | Required within parent | Format: uuid |
Response
Section titled “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 |
|---|---|---|---|
$ | Model | Root | Expand Retrieve ATS job posting — 200 response body |
Referenced models: Retrieve ATS job posting — 200 response body
Schemas
Section titled “Schemas”7 more schemas are linked from the tables above, on the schema pages.
Retrieve ATS job posting — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Successful operation. |
data | Model | Optional | Expand Retrieve ATS job posting — 200 response body — data Job posting with nested job details and publication status. |
Referenced models: Retrieve ATS job posting — 200 response body — data
Retrieve ATS job posting — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job posting with nested job details and publication status. |
application_form | JSON | Optional | Application form assigned to the job posting |
application_form (anyOf 1) | Model | Alternative | Expand Retrieve ATS job posting — 200 response body — data application form Application form assigned to the job posting |
application_form (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Creation timestamp Format: date-time |
id | string | Required within parent | Unique identifier for the job posting Format: uuid |
is_compensation_visible | boolean | Required within parent | Indicates if compensation details are visible to candidates |
job | Model | Required within parent | Expand Retrieve ATS job posting — 200 response body — data job Associated job information |
job_id | string | Required within parent | Identifier of the underlying job this posting belongs to. Format: uuid |
publications | array | Required within parent | Publication rows for this posting, one per job board integration, with current state. |
publications[] | Model | Each item | Expand Retrieve ATS job posting — 200 response body — data publications item |
richtext_description | JSON | Required within parent | |
richtext_description (anyOf 1) | string | Alternative | Rich text description of the job posting |
richtext_description (anyOf 2) | null | Alternative | Rich text description of the job posting |
title | string | Required within parent | Job posting title Maximum length: 200 |
updated_at | string | Required within parent | Last 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Application form assigned to the job posting |
id | string | Required within parent | Unique identifier for the application form Format: uuid |
title | string | Required within parent | Title of the application form |
Retrieve ATS job posting — 200 response body — data job
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Associated job information |
compensation | JSON | Required within parent | Compensation information for the job |
compensation (anyOf 1) | Model | Alternative | Expand Retrieve ATS job posting — 200 response body — data job compensation Compensation information for the job |
compensation (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the job Format: uuid |
job_departments | JSON | Optional | |
job_departments (anyOf 1) | array | Alternative | Departments associated with the job |
job_departments (anyOf 1)[] | Model | Each item | Expand Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item |
job_departments (anyOf 2) | null | Alternative | Departments associated with the job |
job_departments (anyOf 2)[] | Model | Each item | Expand Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item |
job_employment_types | array | Required within parent | Employment types associated with the job |
job_employment_types[] | Model | Each item | Expand Retrieve ATS job posting — 200 response body — data job job employment types item |
job_locations | array | Required within parent | Locations associated with the job |
job_locations[] | Model | Each item | Expand Retrieve ATS job posting — 200 response body — data job job locations item |
job_teams | JSON | Optional | |
job_teams (anyOf 1) | array | Alternative | Teams associated with the job |
job_teams (anyOf 1)[] | Model | Each item | Expand Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item |
job_teams (anyOf 2) | null | Alternative | Teams associated with the job |
job_teams (anyOf 2)[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Publication information for different job boards |
current_state | Model | Required within parent | Expand Retrieve ATS job posting — 200 response body — data publications item current state Current publication state details |
id | string | Required within parent | Unique identifier for the job posting publication Format: uuid |
job_board | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employment_type | Model | Required within parent | Expand Retrieve ATS job posting — 200 response body — data job job employment types item employment type Details for the employment type assigned to the job |
id | string | Required within parent | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the job location Format: uuid |
location | Model | Required within parent | Expand 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 job job teams Teams associated with the job item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the job team Format: uuid |
team | Model | Required within parent | Expand Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item team Details for the team assigned to the job |
Referenced models: Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item team
Retrieve ATS job posting — 200 response body — data publications item job board
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job board where the posting is published |
id | string | Required within parent | Unique identifier for the job board Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.atsjobpostings_retrieveatsjobposting. Catalog operation: atsjobpostings_retrieveatsjobposting. 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"}