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.
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"]["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 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_alist_of_ats_hires(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.cursor | string | Optional | Maximum length: 1000 |
query.limit | integer | Optional | Default: 30 Maximum: 100 Minimum: 1 |
query.updated_after | string | Optional | Format: date-time |
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 a list of ATS hires — 200 response body |
Referenced models: Retrieve a list of ATS hires — 200 response body
Schemas
Section titled “Schemas”Retrieve a list of ATS hires — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of application-to-HRIS-profile records, ordered by updated_at ascending. |
data[] | Model | Each item | Expand Retrieve a list of ATS hires — 200 response body — data item |
has_more | boolean | Required within parent | Whether more pages are available beyond the current one. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to fetch the next page; null when there are no more pages. |
next_cursor (anyOf 2) | null | Alternative | Cursor to fetch the next page; null when there are no more pages. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of hires matching the filters. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_id | string | Required within parent | Identifier of the ATS application that was moved to HRIS Format: uuid |
candidate_id | string | Required within parent | Identifier of the candidate the application belongs to Format: uuid |
draft_quote_id | JSON | Required within parent | |
draft_quote_id (anyOf 1) | string | Alternative | Identifier of the draft quote associated with this hire. Null when no draft quote exists. Format: uuid |
draft_quote_id (anyOf 2) | null | Alternative | Identifier of the draft quote associated with this hire. Null when no draft quote exists. Format: uuid |
hris_profile_id | JSON | Required within parent | |
hris_profile_id (anyOf 1) | JSON | Alternative | |
hris_profile_id (anyOf 1) (anyOf 1) | integer | Alternative | Numeric 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hris_profile_id (anyOf 2) | null | Alternative | Numeric identifier of the HRIS profile the application was hired into. Null while the profile does not exist yet. |
hris_profile_public_id | JSON | Required within parent | |
hris_profile_public_id (anyOf 1) | string | Alternative | Public (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) | null | Alternative | Public (UUID) identifier of the same HRIS profile as hris_profile_id. Null while the profile does not exist yet. Format: uuid |
offer_id | string | Required within parent | Identifier of the accepted offer the hire was created from Format: uuid |
organization_id | string | Required within parent | Identifier of the organization that owns the record Format: uuid |
status_enum | string | Required within parent | State 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_at | string | Required within parent | Timestamp 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_id | JSON | Required within parent | |
worker_id (anyOf 1) | JSON | Alternative | |
worker_id (anyOf 1) (anyOf 1) | integer | Alternative | Worker identifier of the same HRIS profile. Null while the profile does not exist yet. |
worker_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
worker_id (anyOf 2) | null | Alternative | Worker identifier of the same HRIS profile. Null while the profile does not exist yet. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}