A contact is a record in a user’s database that contains at least an email address and is not associated with any survey in the account.
To add a respondent to a survey, a contact must be created. A contact is a link between the respondent entity and the survey.
Neither contacts nor respondents have to be unique within a user account.
Operations on respondents can be found in the next section called ‘Respondents’
List of operations for a resource
Name | URL | Description |
/ | Returns a contact list. Contacts are sorted according to the email address, alphabetically. | |
| Searches contacts according to the criteria specified in the POST table | |
| Adds contact to the contact list of a logged in user | |
| Adds contact to the contact list (for offline distribution, the email is not required) | |
| Returns a list of contact groups on the user account. |
Description of the response parameters
Name/path | Description | Possible values |
| Contact ID |
|
| Email address |
|
| Value of the first optional label. Label active if defined in the user account. |
|
| Value of the second optional label. Label active if defined in the user account. |
|
| Value of the third optional label. Label active if defined in the user account. |
|
| Value of the fourth optional label. Label active if defined in the user account. |
|
| Value of the fifth optional label. Label active if defined in the user account. |
|
| Value of the sixth optional label. Label active if defined in the user account. |
|
| Value of the seventh optional label. Label active if defined in the user account. |
|
| Value of the eighth optional label. Label active if defined in the user account. |
|
| Value of the ninth optional label Label active if defined in the user account. |
|
| Value of the tenth optional label. Label active if defined in the user account. |
|
| Value of the eleventh optional. label Label active if defined in the user account. |
|
| Value of the twelfth optional label. Label active if defined in the user account. |
|
| Value of the thirteenth optional label. Label active if defined in the user account. |
|
| Value of the fourteenth optional label. Label active if defined in the user account. |
|
| Value of the fifteenth optional label. Label active if defined in the user account. |
|
Contact list
URL
(GET) https://www.startquestion.com/api/v2/contacts
Optional parameters (POST)
Name | Description |
| Contact group ID |
| Limit for the number of fillings |
| Offset for the list |
Sample response
{
"total":"20",
"list":[{
"id":100824,
"email":"jan@kowalski.pl",
"label1":"Jan",
"label2":"Kowalski",
"label3":"600 700 800",
"label4":"",
"label5":""
},{
...
}]
}
Returned errors
401 Unauthorized
– If the user refers to a foreign resource
404 Not Found
– If a group with the specified: id_group was not found.
404 Not Found
– If no contacts were found.
Contact search
URL
(GET) https://www.startquestion.com/api/v2/contacts
Optional parameters (POST)
Name | Description |
| Limit for the number of fillings |
| Offset for the list |
| Searching for a respondent by email address |
| Searching for a respondent by label 1 value |
| Searching for a respondent by label 2 value |
| Searching for a respondent by label 3 value |
| Searching for a respondent by label 4 value |
| Searching for a respondent by label 5 value |
| Searching for a respondent by label 6 value |
| Searching for a respondent by label 7 value |
| Searching for a respondent by label 8 value |
| Searching for a respondent by label 9 value |
| Searching for a respondent by label 10 value |
Sample response
{
"total":"20",
"list":[{
"id":100824,
"email":"jan@kowalski.pl",
"label1":"Jan",
"label2":"Kowalski",
"label3":"600 700 800",
"label4":"",
"label5":""
},{
...
}]
}
Returned errors
401 Unauthorized
– If the user refers to a foreign resource
Adding contacts
URL
(GET) https://www.startquestion.com/api/v2/contacts/add
Parameters (POST)
Name | Description |
| Email address (mandatory parameter) |
| ID of the group to which the contact will be added. Optional parameter |
| Label 1 value |
| Label 2 value |
| Label 3 value |
| Label 4 value |
| Label 5 value |
| Label 6 value |
| Label 7 value |
| Label 8 value |
| Label 9 value |
| Label 10 value |
| Label 11 value |
| Label 12 value |
| Label 13 value |
| Label 14 value |
| Label 15 value |
Sample response
{
"id_contact":"149768"
}
Returned errors
406 Not Acceptable
– If mandatory parameters were not specified.
Adding offline contacts (without email address)
URL
(GET) https://www.startquestion.com/api/v2/contacts/add
Parameters (POST)
Name | Description |
| User token (mandatory parameter) |
| ID of the group to which the contact will be added. Optional parameter |
| Label 1 value |
| Label 2 value |
| Label 3 value |
| Label 4 value |
| Label 5 value |
| Label 6 value |
| Label 7 value |
| Label 8 value |
| Label 9 value |
| Label 10 value |
| Label 11 value |
| Label 12 value |
| Label 13 value |
| Label 14 value |
| Label 15 value |
Sample response
{
"id_contact":"149768"
}
Returned errors
406 Not Acceptable
– If mandatory parameters were not specified.
Contact group list
URL
(GET) https://www.startquestion.com/api/v2/contacts/group-list
Sample response
[
{
"id":9,
"name":"Pracownicy"
},
{
"id":15,
"name":"Klienci"
}
]
Returned errors
None