Skip to content

Deel: Retrieve ATS hiring members

Deel atsHiringMembers.retrieveAtsHiringMembers: arguments, response, policy and SDK examples.

← ATS hiring members operations · Get started

Operation deel.atshiringmembers_retrieveatshiringmembers

Provider route: GET /ats/hiring-members. 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["atsHiringMembers"]["retrieveAtsHiringMembers"]>[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.atsHiringMembers.retrieveAtsHiringMembers(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_hiring_members.retrieve_ats_hiring_members(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.cursorstringOptional
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
query.job_idstringOptionalFormat: uuid

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

Referenced models: Retrieve ATS hiring members — 200 response body

Retrieve ATS hiring members — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of resources.
data[]ModelEach itemExpand Retrieve ATS hiring members — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more items to fetch.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page of results
next_cursor (anyOf 2)nullAlternativeCursor for the next page of results
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of users
Minimum: 0
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve ATS hiring members — 200 response body — data item

Retrieve ATS hiring members — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentCreation timestamp
Format: date-time
first_namestringRequired within parentUser's first name
hris_organization_user_idstringRequired within parentUnique identifier for the HRIS organization user
idstringRequired within parentUnique identifier
Format: uuid
job_idJSONOptional
job_id (anyOf 1)stringAlternativeJob this hiring team membership belongs to. A person on several hiring teams appears once per job.
Format: uuid
job_id (anyOf 2)nullAlternativeJob this hiring team membership belongs to. A person on several hiring teams appears once per job.
Format: uuid
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeUser's job title
job_title (anyOf 2)nullAlternativeUser's job title
last_namestringRequired within parentUser's last name
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeURL to the user's profile picture
Format: uri
pic_url (anyOf 2)nullAlternativeURL to the user's profile picture
Format: uri
role_idJSONOptional
role_id (anyOf 1)JSONAlternative
role_id (anyOf 1) (anyOf 1)integerAlternativeIdentifier of the person's role on the job, as defined in roles and permissions. Pair with role_name for display. Null for organizations that do not use roles and permissions.
role_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
role_id (anyOf 2)nullAlternativeIdentifier of the person's role on the job, as defined in roles and permissions. Pair with role_name for display. Null for organizations that do not use roles and permissions.
role_nameJSONOptional
role_name (anyOf 1)stringAlternativeDisplay name of the role on the job, including custom roles. Null for organizations that do not use roles and permissions.
role_name (anyOf 2)nullAlternativeDisplay name of the role on the job, including custom roles. Null for organizations that do not use roles and permissions.
updated_atJSONOptional
updated_at (anyOf 1)stringAlternativeLast update timestamp
Format: date-time
updated_at (anyOf 2)nullAlternativeLast update timestamp
Format: date-time
work_emailstringRequired within parentUser's work email address
Format: email

SDK function policy ID: deel.atshiringmembers_retrieveatshiringmembers. Catalog operation: atshiringmembers_retrieveatshiringmembers. 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"}

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.