Countries & qualifications

Before you impanel a participant, fetch the supported countries and the qualification questions for that country. The values returned here are what you send as country_id and profile_data to the Impanel endpoint.

GET /countries

List all countries where campaigns are available.

Parameters

Type	Name	Required	Description
Header	X-Api-Token	Yes	Your API token.

Response

Returns an object with a countries array.

Field	Description
id	Internal numeric country ID.
name	Country name.

{
  "countries": [
    { "id": 1, "name": "United States" },
    { "id": 2, "name": "Canada" }
  ]
}

Use the id value when calling Qualifications and Impanel.

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

Name	Required	Description
X-Api-Token	Yes	Your API token.

Query parameters

Name	Required	Description
country_id	Yes	Country ID returned from /countries.

Response

An object with a qualifications array.

Field	Type	Description
question_id	Integer	Unique question identifier.
question_text	String	Text of the qualification question.
country_id	Integer	The country the question belongs to.
name	String	Short name of the question.
answer_type	String	One of Single select, Multi select, or Text.
qualification_answers	Array	For select types: array of { option_text, pre_code }, where pre_code is an integer. Empty for Text.
required	Boolean	Whether the answer is mandatory.

Example response

{
  "qualifications": [
    {
      "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, such as a ZIP code or a birthdate (YYYY-MM-DD).

---

Next step: Impanel the participant → — register them with their qualification responses so TapResearch can match surveys.