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.
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"]["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 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_ats_application_form(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.application_form_id | string | Required within parent | Format: uuid |
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 ATS Application form — 200 response body |
Referenced models: Retrieve ATS Application form — 200 response body
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
Retrieve ATS Application form — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_confirmation_email_template_id | JSON | Required within parent | |
application_confirmation_email_template_id (anyOf 1) | string | Alternative | Unique identifier for the application confirmation email template Format: uuid |
application_confirmation_email_template_id (anyOf 2) | null | Alternative | Unique identifier for the application confirmation email template Format: uuid |
created_at | string | Required within parent | Timestamp when the application form was created Format: date-time |
demographic_option_types | array | Optional | Array of demographic option types for collecting diversity information |
demographic_option_types[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data demographic option types item |
demographic_section_helper_text | JSON | Required within parent | |
demographic_section_helper_text (anyOf 1) | string | Alternative | Helper text for the demographic section |
demographic_section_helper_text (anyOf 2) | null | Alternative | Helper text for the demographic section |
demographic_section_title | JSON | Required within parent | |
demographic_section_title (anyOf 1) | string | Alternative | Title for the demographic section |
demographic_section_title (anyOf 2) | null | Alternative | Title for the demographic section |
form_builder_form | JSON | Required within parent | Form builder configuration |
form_builder_form (anyOf 1) | Model | Alternative | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration |
form_builder_form (anyOf 2) | null | Alternative | |
form_builder_form_id | JSON | Required within parent | |
form_builder_form_id (anyOf 1) | string | Alternative | Unique identifier for the form builder form Format: uuid |
form_builder_form_id (anyOf 2) | null | Alternative | Unique identifier for the form builder form Format: uuid |
form_builder_form_revision_id | JSON | Required within parent | |
form_builder_form_revision_id (anyOf 1) | string | Alternative | Unique identifier for the form builder form revision Format: uuid |
form_builder_form_revision_id (anyOf 2) | null | Alternative | Unique identifier for the form builder form revision Format: uuid |
has_show_resume_field | boolean | Required within parent | Whether to show the resume field |
id | string | Required within parent | Unique identifier for the application form Format: uuid |
is_linkedin_profile_url_required | boolean | Required within parent | Whether the LinkedIn profile URL field is required |
is_location_city_field_required | boolean | Required within parent | Whether the city field is required, which is only required alongside the country field |
is_location_country_field_required | boolean | Required within parent | Whether the country field is required |
is_phone_number_required | boolean | Required within parent | Whether the phone number field is required |
is_resume_required | boolean | Required within parent | Whether the resume field is required |
organization_id | string | Required within parent | Unique identifier for the organization Format: uuid |
resume_field_helper_text | JSON | Required within parent | |
resume_field_helper_text (anyOf 1) | string | Alternative | Helper text for the resume field |
resume_field_helper_text (anyOf 2) | null | Alternative | Helper text for the resume field |
richtext_description | JSON | Required within parent | |
richtext_description (anyOf 1) | string | Alternative | Rich text description of the application form |
richtext_description (anyOf 2) | null | Alternative | Rich text description of the application form |
sensitive_fields_ids | JSON | Required within parent | |
sensitive_fields_ids (anyOf 1) | array | Alternative | Array of sensitive field IDs |
sensitive_fields_ids (anyOf 1)[] | string | Each item | Format: uuid |
sensitive_fields_ids (anyOf 2) | null | Alternative | Array of sensitive field IDs |
sensitive_fields_ids (anyOf 2)[] | string | Each item | Format: uuid |
should_show_location_city_field | boolean | Required within parent | Whether to show the city field, which is only shown alongside the country field |
should_show_location_country_field | boolean | Required within parent | Whether to show the country field |
status_enum | string | Required within parent | Status of the application form Known values: DRAFT, PUBLISHED, ARCHIVED |
title | string | Required within parent | Title of the application form |
updated_at | string | Required within parent | Timestamp 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
helper_text | JSON | Optional | |
helper_text (anyOf 1) | string | Alternative | Helper text for the option type |
helper_text (anyOf 2) | null | Alternative | Helper text for the option type |
id | string | Optional | Unique identifier for the demographic option type Format: uuid |
option_type_slug | string | Optional | Slug for the option type |
options | array | Optional | Array of available options for this demographic type |
options[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Form builder configuration |
pages | array | Required within parent | List of pages in the form |
pages[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Unique identifier for the option Format: uuid |
value | string | Optional | Value of the option |
Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pages in the form |
sections | array | Required within parent | Sections within the page |
sections[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item |
title | string | Required within parent | Title 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Sections within the page |
questions | array | Required within parent | List of questions within the section |
questions[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item |
subtitle | string | Optional | Additional information shown at the top of the section |
title | string | Required within parent | Title 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines dynamic data source for the question |
definition | string | Optional | Reference URL for API documentation |
description | string | Optional | Description of the data source |
url | string | Optional | API endpoint providing dynamic options |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}