Skip to content

Deel: Retrieve ATS Application form

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

← ATS operations · Get started

Operation deel.ats_retrieveatsapplicationform_v2026_01_01

Provider route: GET /ats/application-forms/{application_form_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"]["retrieveAtsApplicationForm"]>[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.retrieveAtsApplicationForm(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_application_form(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.application_form_idstringRequired within parentFormat: 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 Application form — 200 response body

Referenced models: Retrieve ATS Application form — 200 response body

3 more schemas are linked from the tables above, on the schema pages.

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

Referenced models: Retrieve ATS Application form — 200 response body — data

Retrieve ATS Application form — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
application_confirmation_email_template_idJSONRequired within parent
application_confirmation_email_template_id (anyOf 1)stringAlternativeUnique identifier for the application confirmation email template
Format: uuid
application_confirmation_email_template_id (anyOf 2)nullAlternativeUnique identifier for the application confirmation email template
Format: uuid
created_atstringRequired within parentTimestamp when the application form was created
Format: date-time
demographic_option_typesarrayOptionalArray of demographic option types for collecting diversity information
demographic_option_types[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data demographic option types item
demographic_section_helper_textJSONRequired within parent
demographic_section_helper_text (anyOf 1)stringAlternativeHelper text for the demographic section
demographic_section_helper_text (anyOf 2)nullAlternativeHelper text for the demographic section
demographic_section_titleJSONRequired within parent
demographic_section_title (anyOf 1)stringAlternativeTitle for the demographic section
demographic_section_title (anyOf 2)nullAlternativeTitle for the demographic section
form_builder_formJSONRequired within parentForm builder configuration
form_builder_form (anyOf 1)ModelAlternativeExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration
form_builder_form (anyOf 2)nullAlternative
form_builder_form_idJSONRequired within parent
form_builder_form_id (anyOf 1)stringAlternativeUnique identifier for the form builder form
Format: uuid
form_builder_form_id (anyOf 2)nullAlternativeUnique identifier for the form builder form
Format: uuid
form_builder_form_revision_idJSONRequired within parent
form_builder_form_revision_id (anyOf 1)stringAlternativeUnique identifier for the form builder form revision
Format: uuid
form_builder_form_revision_id (anyOf 2)nullAlternativeUnique identifier for the form builder form revision
Format: uuid
has_show_resume_fieldbooleanRequired within parentWhether to show the resume field
idstringRequired within parentUnique identifier for the application form
Format: uuid
is_linkedin_profile_url_requiredbooleanRequired within parentWhether the LinkedIn profile URL field is required
is_location_city_field_requiredbooleanRequired within parentWhether the city field is required, which is only required alongside the country field
is_location_country_field_requiredbooleanRequired within parentWhether the country field is required
is_phone_number_requiredbooleanRequired within parentWhether the phone number field is required
is_resume_requiredbooleanRequired within parentWhether the resume field is required
organization_idstringRequired within parentUnique identifier for the organization
Format: uuid
resume_field_helper_textJSONRequired within parent
resume_field_helper_text (anyOf 1)stringAlternativeHelper text for the resume field
resume_field_helper_text (anyOf 2)nullAlternativeHelper text for the resume field
richtext_descriptionJSONRequired within parent
richtext_description (anyOf 1)stringAlternativeRich text description of the application form
richtext_description (anyOf 2)nullAlternativeRich text description of the application form
sensitive_fields_idsJSONRequired within parent
sensitive_fields_ids (anyOf 1)arrayAlternativeArray of sensitive field IDs
sensitive_fields_ids (anyOf 1)[]stringEach itemFormat: uuid
sensitive_fields_ids (anyOf 2)nullAlternativeArray of sensitive field IDs
sensitive_fields_ids (anyOf 2)[]stringEach itemFormat: uuid
should_show_location_city_fieldbooleanRequired within parentWhether to show the city field, which is only shown alongside the country field
should_show_location_country_fieldbooleanRequired within parentWhether to show the country field
status_enumstringRequired within parentStatus of the application form
Known values: DRAFT, PUBLISHED, ARCHIVED
titlestringRequired within parentTitle of the application form
updated_atstringRequired within parentTimestamp when the application form was last updated
Format: date-time

Referenced models: Retrieve ATS Application form — 200 response body — data demographic option types item, Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration

Retrieve ATS Application form — 200 response body — data demographic option types item
FieldTypePresenceDescription and constraints
$objectRoot
helper_textJSONOptional
helper_text (anyOf 1)stringAlternativeHelper text for the option type
helper_text (anyOf 2)nullAlternativeHelper text for the option type
idstringOptionalUnique identifier for the demographic option type
Format: uuid
option_type_slugstringOptionalSlug for the option type
optionsarrayOptionalArray of available options for this demographic type
options[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data demographic option types item options item

Referenced models: Retrieve ATS Application form — 200 response body — data demographic option types item options item

Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration
FieldTypePresenceDescription and constraints
$objectRootForm builder configuration
pagesarrayRequired within parentList of pages in the form
pages[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item

Referenced models: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item

Retrieve ATS Application form — 200 response body — data demographic option types item options item
FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalUnique identifier for the option
Format: uuid
valuestringOptionalValue of the option
Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item
FieldTypePresenceDescription and constraints
$objectRootPages in the form
sectionsarrayRequired within parentSections within the page
sections[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item
titlestringRequired within parentTitle of the form page

Referenced models: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item

Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item
FieldTypePresenceDescription and constraints
$objectRootSections within the page
questionsarrayRequired within parentList of questions within the section
questions[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item
subtitlestringOptionalAdditional information shown at the top of the section
titlestringRequired within parentTitle of the section

Referenced models: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item

Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item source Defines dynamic data source for the question
FieldTypePresenceDescription and constraints
$objectRootDefines dynamic data source for the question
definitionstringOptionalReference URL for API documentation
descriptionstringOptionalDescription of the data source
urlstringOptionalAPI endpoint providing dynamic options

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