Skip to content

Deel: Retrieve a list of ATS hires

Deel ats.retrieveAlistOfAtsHires: arguments, response, policy and SDK examples.

← ATS operations · Get started

Operation deel.ats_retrievealistofatshires_v2026_10_01

Provider route: GET /ats/hires. 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"]["retrieveAlistOfAtsHires"]>[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.retrieveAlistOfAtsHires(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_alist_of_ats_hires(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.cursorstringOptionalMaximum length: 1000
query.limitintegerOptionalDefault: 30
Maximum: 100
Minimum: 1
query.updated_afterstringOptionalFormat: date-time
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 a list of ATS hires — 200 response body

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

Retrieve a list of ATS hires — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of application-to-HRIS-profile records, ordered by updated_at ascending.
data[]ModelEach itemExpand Retrieve a list of ATS hires — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available beyond the current one.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to fetch the next page; null when there are no more pages.
next_cursor (anyOf 2)nullAlternativeCursor to fetch the next page; null when there are no more pages.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of hires matching the filters.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

Retrieve a list of ATS hires — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
application_idstringRequired within parentIdentifier of the ATS application that was moved to HRIS
Format: uuid
candidate_idstringRequired within parentIdentifier of the candidate the application belongs to
Format: uuid
draft_quote_idJSONRequired within parent
draft_quote_id (anyOf 1)stringAlternativeIdentifier of the draft quote associated with this hire. Null when no draft quote exists.
Format: uuid
draft_quote_id (anyOf 2)nullAlternativeIdentifier of the draft quote associated with this hire. Null when no draft quote exists.
Format: uuid
hris_profile_idJSONRequired within parent
hris_profile_id (anyOf 1)JSONAlternative
hris_profile_id (anyOf 1) (anyOf 1)integerAlternativeNumeric identifier of the HRIS profile the application was hired into. Null while the profile does not exist yet.
hris_profile_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hris_profile_id (anyOf 2)nullAlternativeNumeric identifier of the HRIS profile the application was hired into. Null while the profile does not exist yet.
hris_profile_public_idJSONRequired within parent
hris_profile_public_id (anyOf 1)stringAlternativePublic (UUID) identifier of the same HRIS profile as hris_profile_id. Null while the profile does not exist yet.
Format: uuid
hris_profile_public_id (anyOf 2)nullAlternativePublic (UUID) identifier of the same HRIS profile as hris_profile_id. Null while the profile does not exist yet.
Format: uuid
offer_idstringRequired within parentIdentifier of the accepted offer the hire was created from
Format: uuid
organization_idstringRequired within parentIdentifier of the organization that owns the record
Format: uuid
status_enumstringRequired within parentState of the move to HRIS. DRAFT: a draft quote exists but no contract yet. CREATED: the HRIS profile and contract exist. DRAFT_DELETED: the draft was discarded.
Known values: DRAFT, DRAFT_DELETED, CREATED
updated_atstringRequired within parentTimestamp of the last change to the record. Records are returned oldest change first, so the last row of a drain is a safe watermark.
Format: date-time
worker_idJSONRequired within parent
worker_id (anyOf 1)JSONAlternative
worker_id (anyOf 1) (anyOf 1)integerAlternativeWorker identifier of the same HRIS profile. Null while the profile does not exist yet.
worker_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
worker_id (anyOf 2)nullAlternativeWorker identifier of the same HRIS profile. Null while the profile does not exist yet.

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