Get Application Screening Questions

Endpoint 1 – Get Application Screening Questions

GET /postings/:uuid/configuration

Use this endpoint to fetch a list of screening and diversity questions and possible answers for the job. Integrate these questions into your application experience and include the answers when creating a new candidate application.

  • “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.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
  "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
  }
}

Glossary of Properties

Property Description
question List of application questions to be presented to a candidate.

Question Object

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

Field Object

Property Description
id Identifier of a field within a question. It is unique within a question scope.
label Label displayed next to input field. This is not needed for simple questions as the “question” attribute should be sufficient
type Type of the input field: INPUT_TEXT, INPUT_INT, SINGLE_SELECT, MULTI_SELECT, DATE, RADIO, CHECKBOX, TEXTAREA, INFORMATION
required Specifies if an answer is mandatory for a given field
complianceType Available values: DIVERSITY, EEO, OFCCP
values[…] List of possible answers. it’s used for the following question types: SINGLE_SELECT, MULTI_SELECT, RADIO, CHECKBOX

Value Object

Property Description
id Option identifier (unique within the question field)
label Option label to be displayed

Example Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
{
   "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 date
 
        "id": "startdate#2142142",
        "question": "When are you available to start?",
        "description": "Used to know when candidate can start work",
        "repeatable": false,
        "fields": [{
              "id": "value",
              "type": "data",
              "required": false,
              "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": "singleSelect",
                "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": "inputString",
              "required": false,
              "values": []
          },
          {
              "id": "level",
              "label": "Level",
              "type": "singleSelect",
              "required": false,
              "values": [
                  {
                      "id": "294102193",
                      "label": "Basic"
                  },
                  {
                      "id": "294102193",
                      "label": "Advanced"
                  },
                  {
                      "id": "294102193",
                      "label": "Fluent"
                  }
              ]
          }
        ]
    }
   ] 
}