Skip to content

Deel: Retrieve paginated list of ATS Rejection Archivation reasons

Deel atsReasons.retrievePaginatedListOfAtsRejectionArchivationReasons: arguments, response, policy and SDK examples.

← ATS reasons operations · Get started

Operation deel.atsreasons_retrievepaginatedlistofatsrejectionarchivationreasons_v2026_01_01

Provider route: GET /ats/reasons. 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["atsReasons"]["retrievePaginatedListOfAtsRejectionArchivationReasons"]>[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.atsReasons.retrievePaginatedListOfAtsRejectionArchivationReasons(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_reasons.retrieve_paginated_list_of_ats_rejection_archivation_reasons(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectRequired within parentAdditional keys: not allowed
query.cursorstringOptionalMaximum length: 1000
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
query.searchstringOptionalMaximum length: 500
query.reason_group_slugstringRequired within parentOne of: CANDIDATE_ARCHIVATION, OFFER_REJECTION, JOB_CLOSURE, INTERVIEW_CANCELLATION
query.include_countsstringOptional
query.include_archivedstringOptional
query.subgroup_slugstringOptionalOne of: INTEREST, LOCATION, COMPENSATION, RESPONSIVENESS, QUALIFICATION, FIT, EXPERIENCE, STATUS, ROLE_CHANGE, WITHDREW, BENEFITS, COUNTER_OFFER, REMOTE_WORK, PERSONAL, TIMING, BUDGET, BUSINESS_NEEDS, EXTERNAL_CANDIDATE, INTERNAL_TRANSFER, HIRING_FREEZE

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve paginated list of ATS Rejection Archivation reasons — 200 response body

Referenced models: Retrieve paginated list of ATS Rejection Archivation reasons — 200 response body

Retrieve paginated list of ATS Rejection Archivation reasons — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentArray of reason objects
data[]ModelEach itemExpand Retrieve paginated list of ATS Rejection Archivation reasons — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more results available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for pagination to fetch next page
Maximum length: 1000
next_cursor (anyOf 2)nullAlternativeCursor for pagination to fetch next page
Maximum length: 1000
total_countJSONRequired within parent
total_count (anyOf 1)numberAlternativeTotal count of reasons
Format: double
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve paginated list of ATS Rejection Archivation reasons — 200 response body — data item

Retrieve paginated list of ATS Rejection Archivation reasons — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeTimestamp when the reason was archived; null while the reason is active and selectable
Format: date-time
archived_at (anyOf 2)nullAlternativeTimestamp when the reason was archived; null while the reason is active and selectable
Format: date-time
candidates_countJSONOptional
candidates_count (anyOf 1)JSONAlternative
candidates_count (anyOf 1) (anyOf 1)numberAlternativeNumber of candidates associated with this reason
Format: double
candidates_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
candidates_count (anyOf 2)nullAlternativeNumber of candidates associated with this reason
Format: double
created_atstringRequired within parentTimestamp when the reason was created
Format: date-time
email_templateJSONOptionalAssociated email template
email_template (anyOf 1)ModelAlternativeExpand Retrieve paginated list of ATS Rejection Archivation reasons — 200 response body — data item email template Associated email template
email_template (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the reason
Format: uuid
jobs_countJSONOptional
jobs_count (anyOf 1)JSONAlternative
jobs_count (anyOf 1) (anyOf 1)numberAlternativeNumber of jobs associated with this reason
Format: double
jobs_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
jobs_count (anyOf 2)nullAlternativeNumber of jobs associated with this reason
Format: double
labelstringRequired within parentLabel of the reason
reason_group_slugstringRequired within parentReason group slug
Known values: CANDIDATE_ARCHIVATION, OFFER_REJECTION, JOB_CLOSURE, INTERVIEW_CANCELLATION
subgroup_slugJSONOptionalReason subgroup slug
subgroup_slug (anyOf 1)stringAlternativeReason subgroup slug
Known values: INTEREST, LOCATION, COMPENSATION, RESPONSIVENESS, QUALIFICATION, FIT, EXPERIENCE, STATUS, ROLE_CHANGE, WITHDREW, BENEFITS, COUNTER_OFFER, REMOTE_WORK, PERSONAL, TIMING, BUDGET, BUSINESS_NEEDS, EXTERNAL_CANDIDATE, INTERNAL_TRANSFER, HIRING_FREEZE
subgroup_slug (anyOf 2)nullAlternative
updated_atstringOptionalTimestamp when the reason was last updated
Format: date-time

Referenced models: Retrieve paginated list of ATS Rejection Archivation reasons — 200 response body — data item email template Associated email template

Retrieve paginated list of ATS Rejection Archivation reasons — 200 response body — data item email template Associated email template
FieldTypePresenceDescription and constraints
$objectRootAssociated email template
idstringRequired within parentEmail template ID
Format: uuid
titlestringRequired within parentEmail template title

SDK function policy ID: deel.atsreasons_retrievepaginatedlistofatsrejectionarchivationreasons_v2026_01_01. Catalog operation: atsreasons_retrievepaginatedlistofatsrejectionarchivationreasons_v2026_01_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-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.