Skip to content

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.

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 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.retrieve_ats_offer(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.offer_idstringRequired within parentFormat: uuid
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

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 offer — 200 response body

Referenced models: Retrieve ATS offer — 200 response body

1 more schema is linked from the tables above, on the schema pages.

Retrieve ATS offer — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve ATS offer — 200 response body — data

Referenced models: Retrieve ATS offer — 200 response body — data

Retrieve ATS offer — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
additional_detailsJSONOptional
additional_details (anyOf 1)stringAlternativeAdditional details about the offer
additional_details (anyOf 2)nullAlternativeAdditional details about the offer
applicationModelRequired within parentExpand 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_idstringOptionalApplication interview plan stage identifier
Format: uuid
approval_requestJSONRequired within parentApproval request for the offer. Null when the offer never went through approval.
approval_request (anyOf 1)ModelAlternativeExpand Retrieve ATS offer — 200 response body — data approval request id, requested at, status, updated at
approval_request (anyOf 2)nullAlternative
approval_request_idJSONOptional
approval_request_id (anyOf 1)stringAlternativeApproval request identifier
Format: uuid
approval_request_id (anyOf 2)nullAlternativeApproval request identifier
Format: uuid
approval_rule_idJSONOptional
approval_rule_id (anyOf 1)stringAlternativeApproval rule identifier
Format: uuid
approval_rule_id (anyOf 2)nullAlternativeApproval rule identifier
Format: uuid
attachment_idJSONOptional
attachment_id (anyOf 1)stringAlternativeAttachment identifier
Format: uuid
attachment_id (anyOf 2)nullAlternativeAttachment identifier
Format: uuid
compensation_amountJSONOptional
compensation_amount (anyOf 1)numberAlternativeCompensation amount
Format: double
compensation_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
compensation_currencystringOptionalCompensation currency
compensation_period_slugstringOptionalCompensation period
Known values: annually, monthly, semimonthly, biweekly, weekly, daily, hourly
country_codestringOptionalCountry code
Format: country-code
created_atstringOptionalTimestamp when the offer was created
Format: date-time
custom_fieldsarrayOptionalCustom fields attached to the offer
custom_fields[]ModelEach itemExpand Retrieve ATS offer — 200 response body — data custom fields item
emailJSONOptionalEmail the offer was sent with. Null when the offer was never emailed.
email (anyOf 1)ModelAlternativeExpand Retrieve ATS offer — 200 response body — data email body html, from string, id, recipients bcc, recipients cc, recipients to, subject
email (anyOf 2)nullAlternative
expires_atJSONOptional
expires_at (anyOf 1)stringAlternativeDate when the sent offer expires if the candidate has not responded
Format: date
expires_at (anyOf 2)nullAlternativeDate when the sent offer expires if the candidate has not responded
Format: date
idstringRequired within parentUnique identifier
Format: uuid
job_titlestringOptionalJob title
offer_letter_template_idJSONOptional
offer_letter_template_id (anyOf 1)stringAlternativeOffer letter template identifier
Format: uuid
offer_letter_template_id (anyOf 2)nullAlternativeOffer letter template identifier
Format: uuid
offer_statusstringRequired within parentOffer status
Known values: CREATED, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, SENT, EXPIRED, ACCEPTED, REJECTED
rejection_reason_idJSONOptional
rejection_reason_id (anyOf 1)stringAlternativeRejection reason identifier
Format: uuid
rejection_reason_id (anyOf 2)nullAlternativeRejection reason identifier
Format: uuid
replied_atJSONOptional
replied_at (anyOf 1)stringAlternativeTimestamp when the candidate replied (accepted or rejected) to the offer
Format: date-time
replied_at (anyOf 2)nullAlternativeTimestamp when the candidate replied (accepted or rejected) to the offer
Format: date-time
sent_atJSONOptional
sent_at (anyOf 1)stringAlternativeTimestamp when the offer reached the candidate, through Deel or another channel; null until it has been sent
Format: date-time
sent_at (anyOf 2)nullAlternativeTimestamp when the offer reached the candidate, through Deel or another channel; null until it has been sent
Format: date-time
start_datestringOptionalStart date
Format: date-time
updated_atstringOptionalTimestamp when the offer was last updated
Format: date-time
worker_typestringOptionalWorker 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
FieldTypePresenceDescription and constraints
$objectRootThe 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.
candidateJSONRequired within parentThe candidate who received the offer. Null once the candidate has been deleted or anonymized.
candidate (anyOf 1)ModelAlternativeExpand Retrieve ATS offer — 200 response body — data application candidate first name, id, last name
candidate (anyOf 2)nullAlternative
idstringRequired within parentApplication unique identifier
Format: uuid
jobModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootApproval request for the offer. Null when the offer never went through approval.
idstringRequired within parentUnique identifier of the approval request.
requested_atstringRequired within parentWhen approval was requested.
Format: date-time
statusstringRequired within parentCurrent 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_atstringRequired within parentWhen the approval request last changed.
Format: date-time
Retrieve ATS offer — 200 response body — data custom fields item
FieldTypePresenceDescription and constraints
$objectRootCustom field attached to the offer
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the custom field
description (anyOf 2)nullAlternativeDescription of the custom field
idstringRequired within parentUnique identifier for the custom field
Format: uuid
is_requiredbooleanRequired within parentWhether the custom field is required
namestringRequired within parentCustom field name
typestringRequired within parentType 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
FieldTypePresenceDescription and constraints
$objectRootThe candidate who received the offer. Null once the candidate has been deleted or anonymized.
first_namestringRequired within parentCandidate first name
idstringRequired within parentCandidate unique identifier
Format: uuid
last_namestringRequired within parentCandidate last name
Retrieve ATS offer — 200 response body — data application job
FieldTypePresenceDescription and constraints
$objectRootThe job the application belongs to. The title repeats the offer's own job_title field.
idstringRequired within parentJob unique identifier
Format: uuid
titlestringRequired within parentJob title

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"}

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.