Retrieve ATS Application form

GET

/ats/application-forms/:application_form_id

GET

/rest/ats/application-forms/:application_form_id

curl https://api.letsdeel.com/rest/ats/application-forms/cfe8c14f-741e-4bf8-8090-b9427eeb44c0 \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "id": "cf3bf34f-89e9-49fb-83a5-32104271f261",
    "title": "Software Engineer Application Form",
    "created_at": "2026-01-07T17:51:39.961Z",
    "updated_at": "2026-01-07T17:51:39.961Z",
    "status_enum": "PUBLISHED",
    "organization_id": "3cfbb359-6084-46c0-9d3f-1ed1a1007a7a",
    "form_builder_form": {
      "pages": [
        {
          "title": "Application Questions",
          "sections": [
            {
              "title": "Screening Questions",
              "questions": [
                {
                  "type": "FREETEXT",
                  "title": "What are your salary expectations?",
                  "key": "application.screening.salary_expectations",
                  "rules": [
                    {
                      "title": "Salary Expectation",
                      "source": {
                        "url": "/rest/v2/departments",
                        "definition": "https://api.example.com/docs",
                        "description": "Available departments"
                      },
                      "options": [],
                      "is_range": false,
                      "requires": [
                        null
                      ],
                      "max_value": 1000000,
                      "min_value": 0,
                      "max_length": 255,
                      "min_length": 1,
                      "helper_text": "Enter your expected annual salary",
                      "is_disabled": false,
                      "is_required": true,
                      "number_type": "CURRENCY",
                      "default_value": "Default text value",
                      "is_only_digits": true,
                      "date_limitation": "BLOCK_PAST",
                      "is_multiple_selection": false,
                      "has_request_validation": false
                    }
                  ],
                  "source": {
                    "url": "/rest/v2/departments",
                    "definition": "https://api.example.com/docs",
                    "description": "Available departments"
                  },
                  "options": [
                    {
                      "title": "Yes",
                      "value": "true"
                    }
                  ],
                  "is_range": false,
                  "max_value": 1000000,
                  "min_value": 0,
                  "max_length": 255,
                  "min_length": 1,
                  "helper_text": "Please provide additional details",
                  "is_disabled": false,
                  "is_required": true,
                  "number_type": "CURRENCY",
                  "default_value": "Default text value",
                  "is_only_digits": false,
                  "date_limitation": "BLOCK_PAST",
                  "is_multiple_selection": false,
                  "has_request_validation": true
                }
              ],
              "subtitle": "Please answer the following questions"
            }
          ]
        }
      ]
    },
    "is_resume_required": true,
    "form_builder_form_id": "10164abf-6ea2-4fb9-963c-de2fa2ea4e1b",
    "richtext_description": "<p>Please fill out this form to apply</p>",
    "sensitive_fields_ids": [
      "10164abf-6ea2-4fb9-963c-de2fa2ea4e1b"
    ],
    "has_show_resume_field": true,
    "is_phone_number_required": false,
    "resume_field_helper_text": "Please upload your resume in PDF format",
    "demographic_section_title": "Demographics",
    "form_builder_form_revision_id": "8ed5dd1f-b8ad-4847-b185-eb8209a3d54f",
    "demographic_section_helper_text": "This information is optional and helps us track diversity",
    "is_location_city_field_required": false,
    "should_show_location_city_field": true,
    "is_linkedin_profile_url_required": false,
    "is_location_country_field_required": false,
    "should_show_location_country_field": true,
    "application_confirmation_email_template_id": "10164abf-6ea2-4fb9-963c-de2fa2ea4e1b",
    "demographic_option_types": [
      {
        "id": "10164abf-6ea2-4fb9-963c-de2fa2ea4e1b",
        "options": [
          {
            "id": "8ed5dd1f-b8ad-4847-b185-eb8209a3d54f",
            "value": "Male"
          },
          {
            "id": "9fd6ee2g-c9be-5958-c296-fc9309b4e65g",
            "value": "Female"
          }
        ],
        "helper_text": "Please select your gender identity",
        "option_type_slug": "gender"
      }
    ]
  }
}

Retrieves the definition of an application form, which holds the questions candidates answer when they apply to a job. Use it to interpret the form answers of an application returned by GET /rest/ats/applications/{application_id}.

Token scopes: ats:read, worker:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.deel.training/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

application_form_idstringRequiredformat: "uuid"

Id of the application form

Response

Successful response with application form data

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error