Title
Page icon
Create new category
Edit page index title
Edit category
Edit link
Respondents
The respondents API is a subset of the projects API, allow you to retrieve and optionally manipulate respondents within a project grid.
Respondent Data
Respondent data is provided as a set of key-value pairs, with the key being the column's ID in the project schema.
Values types vary depending on the column type in the schema. Possible value types are:
Strings (for most columns)
String arrays (for multiple choice answers)
Numbers (for numeric columns)
Boolean (for boolean columns)
The following built-in columns also have a first-class presence on the Respondent object. This data is also replicated within the Data object.
Internal Column Name | Respondent Object Mapping |
q_name | FirstName |
q_lastname | LastName |
q_email | |
q_phone | PhoneNumber |
q_country | Country |
q_language | Language |
Moving Respondents
Moving respondents using the API requires the Write Access API feature to be enabled for your tenant.
See API documentation.