Get Application Screening Questions and Privacy Policies

Endpoint 1 – Get Application Screening Questions and Privacy Policies

GET /postings/:uuid/configuration

Use this endpoint to fetch a list of screening and diversity questions and privacy policies for a job. You must integrate these questions into your application experience and include the answers when creating a new candidate application. You must also present the privacy policy links to the user.

  • “X-SmartToken” HTTP header should be added for each request.
  • Pass the UUID as a path parameter when making the request. The UUID is obtained to render the job itself and can be found here.
  • If “avatarUploadAvailable” is set to false, then do not pass the candidate’s avatar.
{
  "questions": [
    {
      "id": "string",
      "label": "string",
      "repeatable": boolean,
      "fields": [
        {
          "id": "string",
          "label": "string",
          "type": "string",
          "required": boolean,
          "complianceType": "string",
          "values": [
            {
              "id": "string",
              "label": "string"
            }
          ]
        }
      ]
    }
  ],
  "settings": {
    "avatarUploadAvailable": false
  }
  "privacyPolicies": [
    {
      "url": "string",
      "orgName": "string"
    }
    {
      "url": "string",
      "orgName": "string"
    }
  ]
}

Glossary of Properties

PropertyDescription
questionList of application questions to be presented to a candidate.

Question Object

PropertyDescription
idUnique identifier of a question
labelGeneral label of the question block label
repeatableIndicates if a question has multiple answers (blocks), e.g. The language question is repeatable because a candidate can enter multiple languages
fields[…]For simple questions “fields” contains exactly one element, for complex questions two or more elements are expected

Field Object

PropertyDescription
idIdentifier of a field within a question. It is unique within a question scope.
labelLabel displayed next to input field. This is not needed for simple questions as the “question” attribute should be sufficient
typeType of the input field: INPUT_TEXT, SINGLE_SELECT, MULTI_SELECT, RADIO, CHECKBOX, TEXTAREA, INFORMATION
requiredSpecifies if an answer is mandatory for a given field
complianceTypeAvailable values: DIVERSITY
values[…]List of possible answers. it’s used for the following question types: SINGLE_SELECT, MULTI_SELECT, RADIO, CHECKBOX

Value Object

PropertyDescription
idOption identifier (unique within the question field)
labelOption label to be displayed

Example Response

{
   "questions" [
    {
        // Simple question of input type string with a required value.
        // Simple questions contain a single field with a "value" id and no Field label.
 
        "id": "faveritebook#12312312",
        "question": "What's your favorite book?",
        "description": "used to store candidate's first name information",
        "repeatable": false,
        "fields": [{
              "id": "value",
              "type": "INPUT_TEXT",
              "required": true,
              "values": []
        }]
    },
    {
        // Simple question of type single select with a required answer
 
        "id": "tennisrating#531424214"
        "question": "How good are you at tennis?"
        "description": "custom question"
        "repeatable": false
        "fields": [
            {
                "id": "value",
                "type": "SINGLE_SELECT",
                "required": true,
                "values": [
                    {
                        "id": "custom521512",
                        "label": "Pro"
                    },
                    { 
                        "id": "custom5121204",
                        "label": "Amateur"
                    }
                ]
            }
        ]
    },
    {
        // Complex question: languages
        // "repeatable" means it is possible to provide multiple field-group answers
 
        "id": "lang#12312312",
        "label": "What languages do you speak?",
        "description": "List the languages that you are at least conversational in ",
        "repeatable": true,
        "fields": [
          {
              "id": "lang",
              "label": "Language",
              "type": "INPUT_TEXT",
              "required": false,
              "values": []
          },
          {
              "id": "level",
              "label": "Level",
              "type": "SINGLE_SELECT",
              "required": false,
              "values": [
                  {
                      "id": "294102193",
                      "label": "Basic"
                  },
                  {
                      "id": "294102193",
                      "label": "Advanced"
                  },
                  {
                      "id": "294102193",
                      "label": "Fluent"
                  }
              ]
          }
        ]
    }
   ] 
  "settings": {
    "avatarUploadAvailable": true
  },
  "privacyPolicies": [
    {
      "url": "https://www.smartrecruiters.com/privacy-policy/?",
      "orgName": "SmartRecruiters"
    }
    {
      "url": "https://www.smartrecruiters.com/CustomerPrivacyPolicy/?",
      "orgName": "CustomerPrivacyPolicy"
    }
  ]
}