Skip to main content
Version: 3.x

GET /qualifications

Retrieve all qualification questions available for a given country.
These questions are used to collect profiling data before a participant is impaneled.


Request

Headers

NameRequiredDescription
X-Api-TokenYour API token.

Query Parameters

NameRequiredDescription
country_idCountry ID returned from /countries.

Response

An array of qualification objects.

FieldTypeDescription
question_idIntegerUnique question identifier.
question_textStringText of the qualification question.
answer_typeStringOne of single select, multi select, or text.
qualification_answersArrayFor select types: array of { option_text, pre_code }.
requiredBooleanWhether the answer is mandatory.

Example Response

[
{
"question_id": 50017,
"question_text": "When were you born?",
"country_id": 1,
"name": "Birthday",
"answer_type": "Text",
"qualification_answers": [],
"required": true
},
{
"question_id": 725,
"question_text": "What are your hobbies and interests? Select all that apply.",
"country_id": 1,
"name": "Hobbies & Interests",
"answer_type": "Multi select",
"qualification_answers": [
{ "option_text": "Arts and Crafts", "pre_code": 1 },
{ "option_text": "Boating", "pre_code": 2 },
{ "option_text": "Cooking", "pre_code": 3 }
],
"required": false
}
]

Notes

  • Use the pre_code values from qualification_answers when sending profile_data in the /players/impanel request.
  • Supported answer types:
    • Single select: user selects one option.
    • Multi select: user can select multiple options.
    • Text: free-form input (e.g., ZIP code, birth year).