Deel: Retrieve ATS Application form — 200 response body — data
Retrieve ATS Application form: 200 response body, field data. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: 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