Deel: Retrieve ATS offer
Deel ats.retrieveAtsOffer: arguments, response, policy and SDK examples.
← ATS operations · Get started
Operation deel.ats_retrieveatsoffer_v2026_10_28
Provider route: GET /ats/offers/{offer_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["ats"]["retrieveAtsOffer"]>[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.ats.retrieveAtsOffer(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.retrieve_ats_offer(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.offer_id | string | Required within parent | Format: uuid |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
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 offer — 200 response body |
Referenced models: Retrieve ATS offer — 200 response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Retrieve ATS offer — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve ATS offer — 200 response body — data |
Referenced models: Retrieve ATS offer — 200 response body — data
Retrieve ATS offer — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_details | JSON | Optional | |
additional_details (anyOf 1) | string | Alternative | Additional details about the offer |
additional_details (anyOf 2) | null | Alternative | Additional details about the offer |
application | Model | Required within parent | Expand Retrieve ATS offer — 200 response body — data application The application this offer was made on, so an offer identifies its own candidate and job without a second lookup. Always present: an offer whose application the caller cannot see is not returned at all. |
application_interview_plan_stage_id | string | Optional | Application interview plan stage identifier Format: uuid |
approval_request | JSON | Required within parent | Approval request for the offer. Null when the offer never went through approval. |
approval_request (anyOf 1) | Model | Alternative | Expand Retrieve ATS offer — 200 response body — data approval request id, requested at, status, updated at |
approval_request (anyOf 2) | null | Alternative | |
approval_request_id | JSON | Optional | |
approval_request_id (anyOf 1) | string | Alternative | Approval request identifier Format: uuid |
approval_request_id (anyOf 2) | null | Alternative | Approval request identifier Format: uuid |
approval_rule_id | JSON | Optional | |
approval_rule_id (anyOf 1) | string | Alternative | Approval rule identifier Format: uuid |
approval_rule_id (anyOf 2) | null | Alternative | Approval rule identifier Format: uuid |
attachment_id | JSON | Optional | |
attachment_id (anyOf 1) | string | Alternative | Attachment identifier Format: uuid |
attachment_id (anyOf 2) | null | Alternative | Attachment identifier Format: uuid |
compensation_amount | JSON | Optional | |
compensation_amount (anyOf 1) | number | Alternative | Compensation amount Format: double |
compensation_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
compensation_currency | string | Optional | Compensation currency |
compensation_period_slug | string | Optional | Compensation period Known values: annually, monthly, semimonthly, biweekly, weekly, daily, hourly |
country_code | string | Optional | Country code Format: country-code |
created_at | string | Optional | Timestamp when the offer was created Format: date-time |
custom_fields | array | Optional | Custom fields attached to the offer |
custom_fields[] | Model | Each item | Expand Retrieve ATS offer — 200 response body — data custom fields item |
email | JSON | Optional | Email the offer was sent with. Null when the offer was never emailed. |
email (anyOf 1) | Model | Alternative | Expand Retrieve ATS offer — 200 response body — data email body html, from string, id, recipients bcc, recipients cc, recipients to, subject |
email (anyOf 2) | null | Alternative | |
expires_at | JSON | Optional | |
expires_at (anyOf 1) | string | Alternative | Date when the sent offer expires if the candidate has not responded Format: date |
expires_at (anyOf 2) | null | Alternative | Date when the sent offer expires if the candidate has not responded Format: date |
id | string | Required within parent | Unique identifier Format: uuid |
job_title | string | Optional | Job title |
offer_letter_template_id | JSON | Optional | |
offer_letter_template_id (anyOf 1) | string | Alternative | Offer letter template identifier Format: uuid |
offer_letter_template_id (anyOf 2) | null | Alternative | Offer letter template identifier Format: uuid |
offer_status | string | Required within parent | Offer status Known values: CREATED, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, SENT, EXPIRED, ACCEPTED, REJECTED |
rejection_reason_id | JSON | Optional | |
rejection_reason_id (anyOf 1) | string | Alternative | Rejection reason identifier Format: uuid |
rejection_reason_id (anyOf 2) | null | Alternative | Rejection reason identifier Format: uuid |
replied_at | JSON | Optional | |
replied_at (anyOf 1) | string | Alternative | Timestamp when the candidate replied (accepted or rejected) to the offer Format: date-time |
replied_at (anyOf 2) | null | Alternative | Timestamp when the candidate replied (accepted or rejected) to the offer Format: date-time |
sent_at | JSON | Optional | |
sent_at (anyOf 1) | string | Alternative | Timestamp when the offer reached the candidate, through Deel or another channel; null until it has been sent Format: date-time |
sent_at (anyOf 2) | null | Alternative | Timestamp when the offer reached the candidate, through Deel or another channel; null until it has been sent Format: date-time |
start_date | string | Optional | Start date Format: date-time |
updated_at | string | Optional | Timestamp when the offer was last updated Format: date-time |
worker_type | string | Optional | Worker type Known values: CONTRACTOR_FIXED, CONTRACTOR_PAY_AS_YOU_GO, CONTRACTOR_MILESTONE, DIRECT_EMPLOYEE, EOR_EMPLOYEE, GLOBAL_PAYROLL_EMPLOYEE, PEO_EMPLOYEE, PWAC, UNKNOWN |
Referenced models: Retrieve ATS offer — 200 response body — data application, Retrieve ATS offer — 200 response body — data approval request id, requested at, status, updated at, Retrieve ATS offer — 200 response body — data custom fields item, Retrieve ATS offer — 200 response body — data email body html, from string, id, recipients bcc, recipients cc, recipients to, subject
Retrieve ATS offer — 200 response body — data application
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The application this offer was made on, so an offer identifies its own candidate and job without a second lookup. Always present: an offer whose application the caller cannot see is not returned at all. |
candidate | JSON | Required within parent | The candidate who received the offer. Null once the candidate has been deleted or anonymized. |
candidate (anyOf 1) | Model | Alternative | Expand Retrieve ATS offer — 200 response body — data application candidate first name, id, last name |
candidate (anyOf 2) | null | Alternative | |
id | string | Required within parent | Application unique identifier Format: uuid |
job | Model | Required within parent | Expand Retrieve ATS offer — 200 response body — data application job The job the application belongs to. The title repeats the offer's own job_title field. |
Referenced models: Retrieve ATS offer — 200 response body — data application candidate first name, id, last name, Retrieve ATS offer — 200 response body — data application job
Retrieve ATS offer — 200 response body — data approval request id, requested at, status, updated at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Approval request for the offer. Null when the offer never went through approval. |
id | string | Required within parent | Unique identifier of the approval request. |
requested_at | string | Required within parent | When approval was requested. Format: date-time |
status | string | Required within parent | Current state of the approval request. PENDING and PARTIALLY_APPROVED mean approvers still have to act. Known values: PENDING, QUEUED, PARTIALLY_APPROVED, APPROVED, REJECTED, CANCELED, SKIPPED |
updated_at | string | Required within parent | When the approval request last changed. Format: date-time |
Retrieve ATS offer — 200 response body — data custom fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Custom field attached to the offer |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the custom field |
description (anyOf 2) | null | Alternative | Description of the custom field |
id | string | Required within parent | Unique identifier for the custom field Format: uuid |
is_required | boolean | Required within parent | Whether the custom field is required |
name | string | Required within parent | Custom field name |
type | string | Required within parent | Type of custom field Known values: TEXT, PERCENTAGE, LIST, MULTISELECT, DATE, NUMBER, CURRENCY, HYPERLINK |
Retrieve ATS offer — 200 response body — data application candidate first name, id, last name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The candidate who received the offer. Null once the candidate has been deleted or anonymized. |
first_name | string | Required within parent | Candidate first name |
id | string | Required within parent | Candidate unique identifier Format: uuid |
last_name | string | Required within parent | Candidate last name |
Retrieve ATS offer — 200 response body — data application job
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The job the application belongs to. The title repeats the offer's own job_title field. |
id | string | Required within parent | Job unique identifier Format: uuid |
title | string | Required within parent | Job title |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.ats_retrieveatsoffer_v2026_10_28. Catalog operation: ats_retrieveatsoffer_v2026_10_28. 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-10-28"}