--- title: Respondent description: >- Respondents are the individuals who participate in your surveys by providing their answers. In this section of the API, you can retrieve responses of a particular respondent and their attributes… source_url: html: 'https://developers.survicate.com/data-export/respondent/' md: 'https://developers.survicate.com/data-export/respondent.md' --- # Respondent Respondents are the individuals who participate in your surveys by providing their answers. In this section of the API, you can retrieve responses of a particular respondent and their attributes passed to Survicate. ## List respondent's attributes GET /respondents/{respondent_uuid}/attributes Retrieves the names and values of custom attributes associated with a specific respondent, which have been passed to Survicate through the JavaScript API, integrations, or embedded within the survey link. ### Required parameters Name: respondent_uuid Type: string Description: The unique identifier (UUID) of the selected respondent. ### Optional parameters Name: items_per_page Type: integer Description: The number of items to display per page in the response. This parameter helps manage the size of each response, making it easier to work with large datasets by breaking them into smaller, paginated results. The minimum value for this parameter is 1, and the maximum is 100. If omitted, the API applies its default page size. Name: start Type: string Description: The unique identifier of the attribute, used to return paginated results. This identifier is included in the response for each request, as part of the 'next_url' parameter. ### Response 200 The operation was successful, and the list of attributes for the requested respondent has been returned. #### Response properties Name: pagination_data.has_more Type: boolean Description: Specifies if additional pages are available for retrieval (True or False). Name: pagination_data.next_url Type: string Description: Path to the next set of paginated results. It is always returned as a path relative to the API base URL (https://data-api.survicate.com/v2), never as an absolute URL, so prepend the base URL and request it as-is. Only present when 'has_more' is true. Name: data[0].id Type: integer Description: The attribute's unique identifier. Name: data[0].name Type: string Description: The attribute's name, exactly as you passed it to Survicate. Name: data[0].value Type: string Description: The attribute's value, returned as a string. Name: data Type: [{"id":{"value":"integer","description":"The attribute's unique identifier."},"name":{"value":"string","description":"The attribute's name, exactly as you passed it to Survicate."},"value":{"value":"string","description":"The attribute's value, returned as a string."}}] Description: A collection of custom attributes that provide additional information about the respondent ```json { "pagination_data": { "has_more": { "value": true, "description": "Specifies if additional pages are available for retrieval (True or False)." }, "next_url": { "value": "/respondents/7232ddb7-d08a-4fcb-9de8-f77ab73f227e/attributes?start=2", "description": "Path to the next set of paginated results. It is always returned as a path relative to the API base URL (https://data-api.survicate.com/v2), never as an absolute URL, so prepend the base URL and request it as-is. Only present when 'has_more' is true." } }, "data": { "value": [ { "id": { "value": 2345, "description": "The attribute's unique identifier." }, "name": { "value": "order_id", "description": "The attribute's name, exactly as you passed it to Survicate." }, "value": { "value": "A-1024", "description": "The attribute's value, returned as a string." } } ], "description": "A collection of custom attributes that provide additional information about the respondent" } } ``` ### Response 404 The specified respondent could not be found. --- ## List respondent's responses GET /respondents/{respondent_uuid}/responses Retrieves a list of survey responses provided by a specific respondent identified by their unique identifier (UUID). Response objects on this endpoint carry empty attribute arrays - both 'respondent.attributes' and the response-level 'attributes' are always empty here; use the respondent attributes endpoint to retrieve the respondent's attributes. ### Required parameters Name: respondent_uuid Type: string Description: The unique identifier (UUID) of the respondent whose responses are being requested. ### Optional parameters Name: items_per_page Type: integer Description: The number of items to display per page in the response. This parameter helps manage the size of each response, making it easier to work with large datasets by breaking them into smaller, paginated results. The minimum value for this parameter is 1, and the maximum is 100. If omitted, the API applies its default page size. Name: start Type: string Description: Optional newer bound of the time range, and the point the page starts from. Responses are ordered from latest to oldest, so 'start' is the later of the two timestamps: responses collected at or before it are included (inclusive). The timestamp should be in the ISO 8601 format, including microseconds (e.g., '2023-01-01T00:00:00.000000Z'). See the Pagination section of the setup guide for a full walkthrough. ### Response 200 The operation was successful, and the list of responses for the requested respondent has been returned. #### Response properties Name: pagination_data.has_more Type: boolean Description: Specifies if additional pages are available for retrieval (True or False). Name: pagination_data.next_url Type: string Description: Path to the next set of paginated results. It is always returned as a path relative to the API base URL (https://data-api.survicate.com/v2), never as an absolute URL, so prepend the base URL and request it as-is. Only present when 'has_more' is true. Name: data[0].survey.id Type: string Description: The survey's unique unchangeable identifier. Name: data[0].survey.type Type: PageSurvey | WidgetSurvey | MobileSurvey | IntercomSurvey Description: The survey's unchangeable type. The type of survey corresponds to the distribution method the survey is delivered to your respondents: * PageSurvey is Email & Sharable Link Survey * WidgetSurvey is Web & In-Product Survey * MobileSurvey is Mobile App Survey * IntercomSurvey is Intercom Messenger Survey Name: data[0].survey.name Type: string Description: The name of the survey. Name: data[0].response.uuid Type: string Description: A unique, unchangeable identifier for the response. Name: data[0].response.collected_at Type: string Description: This timestamp marks the moment a survey response was received, formatted in ISO 8601 with microseconds included (e.g., '2023-01-01T00:00:00.000000Z'). Name: data[0].response.url Type: string Description: The URL where the survey was displayed to the respondent. Name: data[0].response.device_type Type: Desktop | Mobile | Tablet | Tv Description: The type of device used by the respondent to submit the response. Name: data[0].response.operating_system Type: Android | OS | iOS | Linux | macOS | Windows | Other Description: The operating system of the device used by the respondent. Name: data[0].response.platform Type: string Description: The platform identifier of the device used by the respondent (e.g., 'MacIntel', 'Win32'). Name: data[0].response.language Type: string Description: If present, the language of the survey translation presented to the respondent. Name: data[0].response.answers[0].question_id Type: integer Description: The question's unique unchangeable identifier. Name: data[0].response.answers[0].question_type Type: single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat Description: The question's type Name: data[0].response.answers[0].answer.id Type: integer Description: An abstract entity to build other classes. The answer's unique unchangeable identifier. Name: data[0].response.answers[0].answer.content Type: string Description: The respondent's selected answer content. Name: data[0].response.answers[0].answer.comment Type: string Description: Optional text input provided by the respondent as an additional comment to the selected response. Name: data[0].response.answers[0].answers[0].id Type: integer Description: An abstract entity to build other classes. The answer's unique unchangeable identifier. Name: data[0].response.answers[0].answers[0].content Type: string Description: The respondent's selected answer content. Name: data[0].response.answers[0].answers[0].comment Type: string Description: Optional text input provided by the respondent as an additional comment to the selected response. Name: data[0].response.answers[0].answer.rating Type: integer Description: Numerical value representing the respondent's rating. Name: data[0].response.answers[0].fields[0].type Type: string Description: The type of field in the contact form, as chosen by the user through the Survicate interface. Name: data[0].response.answers[0].fields[0].content Type: string Description: The respondent's input for a specific field. Name: data[0].response.answers[0].answer.tag Type: detractor | passive | promoter Description: This represents the NPS group associated with the score selected by the respondent. The options include: * detractor (score 0-6) * passive (score 7-8) * promoter (score 9-10) Name: data[0].response.answers[0].answers[0].score Type: string Description: Label of the selected option in a matrix choice question. Name: data[0].response.answers[0].answers[0].rank Type: integer Description: The selected position of the respondent's choice in the ranking question. Name: data[0].response.answers Type: [{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answer":{"id":{"value":"integer","description":"An abstract entity to build other classes. The answer's unique unchangeable identifier."},"content":{"value":"string","description":"The respondent's selected answer content."},"comment":{"value":"string","description":"Optional text input provided by the respondent as an additional comment to the selected response."}}},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answers":[{"id":{"value":"integer","description":"An abstract entity to build other classes. The answer's unique unchangeable identifier."},"content":{"value":"string","description":"The respondent's selected answer content."},"comment":{"value":"string","description":"Optional text input provided by the respondent as an additional comment to the selected response."}}]},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answer":{"id":{"value":"integer","description":"An abstract entity to build other classes. The answer's unique unchangeable identifier."},"content":{"value":"string","description":"The respondent's selected answer content."},"rating":{"value":"integer","description":"Numerical value representing the respondent's rating."}}},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"fields":[{"type":{"value":"string","description":"The type of field in the contact form, as chosen by the user through the Survicate interface."},"content":{"value":"string","description":"The respondent's input for a specific field."}}]},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answer":"string"},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answer":{"content":{"value":"string","description":"Numerical value of the Net Promoter Score (NPS) chosen by the respondent."},"tag":{"value":"detractor | passive | promoter","description":"This represents the NPS group associated with the score selected by the respondent. The options include:\n* detractor (score 0-6)\n* passive (score 7-8)\n* promoter (score 9-10)\n"}}},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answers":[{"id":{"value":"integer","description":"An abstract entity to build other classes. The answer's unique unchangeable identifier."},"content":{"value":"string","description":"The respondent's selected answer content."},"score":{"value":"string","description":"Label of the selected option in a matrix choice question."}}]},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answers":[{"id":{"value":"integer","description":"An abstract entity to build other classes. The answer's unique unchangeable identifier."},"content":{"value":"string","description":"The respondent's selected answer content."},"rank":{"value":"integer","description":"The selected position of the respondent's choice in the ranking question."}}]},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"action_performed":"boolean"}] Description: An array of answers provided by the respondent for each specific question in the survey. Questions the respondent skipped are not included. Name: data[0].response.respondent.uuid Type: string Description: A unique, unchangeable identifier for the respondent. Name: data[0].response.respondent.attributes[0].name Type: string Description: The attribute's name, exactly as you passed it to Survicate. Name: data[0].response.respondent.attributes[0].value Type: string Description: The attribute's value, always returned as a string. Name: data[0].response.respondent.attributes Type: [{"name":{"value":"string","description":"The attribute's name, exactly as you passed it to Survicate."},"value":{"value":"string","description":"The attribute's value, always returned as a string."}}] Description: The respondent's customer-defined attributes. Which names appear here depends on the endpoint's 'attributes[]' query parameter - see the endpoint descriptions. These are name/value pairs you passed to Survicate yourself; Survicate does not add attributes of its own, so a field such as 'survey_type' only appears here if you set it. Name: data[0].response.attributes[0].name Type: string Description: The attribute's name, exactly as you passed it to Survicate. Name: data[0].response.attributes[0].value Type: string Description: The attribute's value, always returned as a string. Name: data[0].response.attributes Type: [{"name":{"value":"string","description":"The attribute's name, exactly as you passed it to Survicate."},"value":{"value":"string","description":"The attribute's value, always returned as a string."}}] Description: Customer-defined attributes recorded with this specific response, as name/value pairs - for example campaign identifiers passed with the survey link. What is returned here depends on the endpoint: the response list returns only the names listed in the 'attributes[]' query parameter (empty when omitted), the single-response endpoint always returns all of them - see the endpoint descriptions. Attributes of the person are returned under 'respondent.attributes' instead. Native response fields (for example 'uuid', 'collected_at', 'url', 'device_type', 'operating_system' and 'language') are returned as top-level properties of the response, not as attributes. Name: data Type: [{"survey":{"id":{"value":"string","description":"The survey's unique unchangeable identifier."},"type":{"value":"PageSurvey | WidgetSurvey | MobileSurvey | IntercomSurvey","description":"The survey's unchangeable type. The type of survey corresponds to the distribution method the survey is delivered to your respondents:\n* PageSurvey is Email & Sharable Link Survey\n* WidgetSurvey is Web & In-Product Survey\n* MobileSurvey is Mobile App Survey\n* IntercomSurvey is Intercom Messenger Survey\n"},"name":{"value":"string","description":"The name of the survey."}},"response":{"uuid":{"value":"string","description":"A unique, unchangeable identifier for the response."},"collected_at":{"value":"string","description":"This timestamp marks the moment a survey response was received, formatted in ISO 8601 with microseconds included (e.g., '2023-01-01T00:00:00.000000Z')."},"url":{"value":"string","description":"The URL where the survey was displayed to the respondent."},"device_type":{"value":"Desktop | Mobile | Tablet | Tv","description":"The type of device used by the respondent to submit the response."},"operating_system":{"value":"Android | OS | iOS | Linux | macOS | Windows | Other","description":"The operating system of the device used by the respondent."},"platform":{"value":"string","description":"The platform identifier of the device used by the respondent (e.g., 'MacIntel', 'Win32')."},"language":{"value":"string","description":"If present, the language of the survey translation presented to the respondent."},"answers":{"value":[{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answer":{"id":{"value":"integer","description":"An abstract entity to build other classes. The answer's unique unchangeable identifier."},"content":{"value":"string","description":"The respondent's selected answer content."},"comment":{"value":"string","description":"Optional text input provided by the respondent as an additional comment to the selected response."}}},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answers":[{"id":{"value":"integer","description":"An abstract entity to build other classes. The answer's unique unchangeable identifier."},"content":{"value":"string","description":"The respondent's selected answer content."},"comment":{"value":"string","description":"Optional text input provided by the respondent as an additional comment to the selected response."}}]},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answer":{"id":{"value":"integer","description":"An abstract entity to build other classes. The answer's unique unchangeable identifier."},"content":{"value":"string","description":"The respondent's selected answer content."},"rating":{"value":"integer","description":"Numerical value representing the respondent's rating."}}},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"fields":[{"type":{"value":"string","description":"The type of field in the contact form, as chosen by the user through the Survicate interface."},"content":{"value":"string","description":"The respondent's input for a specific field."}}]},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answer":"string"},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answer":{"content":{"value":"string","description":"Numerical value of the Net Promoter Score (NPS) chosen by the respondent."},"tag":{"value":"detractor | passive | promoter","description":"This represents the NPS group associated with the score selected by the respondent. The options include:\n* detractor (score 0-6)\n* passive (score 7-8)\n* promoter (score 9-10)\n"}}},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answers":[{"id":{"value":"integer","description":"An abstract entity to build other classes. The answer's unique unchangeable identifier."},"content":{"value":"string","description":"The respondent's selected answer content."},"score":{"value":"string","description":"Label of the selected option in a matrix choice question."}}]},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"answers":[{"id":{"value":"integer","description":"An abstract entity to build other classes. The answer's unique unchangeable identifier."},"content":{"value":"string","description":"The respondent's selected answer content."},"rank":{"value":"integer","description":"The selected position of the respondent's choice in the ranking question."}}]},{"question_id":{"value":"integer","description":"The question's unique unchangeable identifier."},"question_type":{"value":"single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat","description":"The question's type"},"action_performed":"boolean"}],"description":"An array of answers provided by the respondent for each specific question in the survey. Questions the respondent skipped are not included."},"respondent":{"value":{"uuid":{"value":"string","description":"A unique, unchangeable identifier for the respondent."},"attributes":{"value":[{"name":{"value":"string","description":"The attribute's name, exactly as you passed it to Survicate."},"value":{"value":"string","description":"The attribute's value, always returned as a string."}}],"description":"The respondent's customer-defined attributes. Which names appear here depends on the endpoint's 'attributes[]' query parameter - see the endpoint descriptions. These are name/value pairs you passed to Survicate yourself; Survicate does not add attributes of its own, so a field such as 'survey_type' only appears here if you set it."}},"description":"The respondent who submitted the response."},"attributes":{"value":[{"name":{"value":"string","description":"The attribute's name, exactly as you passed it to Survicate."},"value":{"value":"string","description":"The attribute's value, always returned as a string."}}],"description":"Customer-defined attributes recorded with this specific response, as name/value pairs - for example campaign identifiers passed with the survey link. What is returned here depends on the endpoint: the response list returns only the names listed in the 'attributes[]' query parameter (empty when omitted), the single-response endpoint always returns all of them - see the endpoint descriptions. Attributes of the person are returned under 'respondent.attributes' instead. Native response fields (for example 'uuid', 'collected_at', 'url', 'device_type', 'operating_system' and 'language') are returned as top-level properties of the response, not as attributes."}}}] Description: Responses of the respondent. ```json { "pagination_data": { "has_more": { "value": true, "description": "Specifies if additional pages are available for retrieval (True or False)." }, "next_url": { "value": "/respondents/7232ddb7-d08a-4fcb-9de8-f77ab73f227e/responses?start=2023-01-01T00:00:00.000000Z", "description": "Path to the next set of paginated results. It is always returned as a path relative to the API base URL (https://data-api.survicate.com/v2), never as an absolute URL, so prepend the base URL and request it as-is. Only present when 'has_more' is true." } }, "data": { "value": [ { "survey": { "id": { "value": "69f3dcf0d3220de7", "description": "The survey's unique unchangeable identifier." }, "type": { "value": "PageSurvey | WidgetSurvey | MobileSurvey | IntercomSurvey", "description": "The survey's unchangeable type. The type of survey corresponds to the distribution method the survey is delivered to your respondents:\n* PageSurvey is Email & Sharable Link Survey\n* WidgetSurvey is Web & In-Product Survey\n* MobileSurvey is Mobile App Survey\n* IntercomSurvey is Intercom Messenger Survey\n" }, "name": { "value": "Customer satisfaction survey", "description": "The name of the survey." } }, "response": { "uuid": { "value": "sample string", "description": "A unique, unchangeable identifier for the response." }, "collected_at": { "value": "sample string", "description": "This timestamp marks the moment a survey response was received, formatted in ISO 8601 with microseconds included (e.g., '2023-01-01T00:00:00.000000Z')." }, "url": { "value": "https://survicate.com/", "description": "The URL where the survey was displayed to the respondent." }, "device_type": { "value": "Desktop | Mobile | Tablet | Tv", "description": "The type of device used by the respondent to submit the response." }, "operating_system": { "value": "Android | OS | iOS | Linux | macOS | Windows | Other", "description": "The operating system of the device used by the respondent." }, "platform": { "value": "MacIntel", "description": "The platform identifier of the device used by the respondent (e.g., 'MacIntel', 'Win32')." }, "language": { "value": "en", "description": "If present, the language of the survey translation presented to the respondent." }, "answers": { "value": [ { "question_id": { "value": 0, "description": "The question's unique unchangeable identifier." }, "question_type": { "value": "single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat", "description": "The question's type" }, "answer": { "id": { "value": 0, "description": "An abstract entity to build other classes. The answer's unique unchangeable identifier." }, "content": { "value": "sample string", "description": "The respondent's selected answer content." }, "comment": { "value": "sample string", "description": "Optional text input provided by the respondent as an additional comment to the selected response." } } }, { "question_id": { "value": 0, "description": "The question's unique unchangeable identifier." }, "question_type": { "value": "single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat", "description": "The question's type" }, "answers": [ { "id": { "value": 0, "description": "An abstract entity to build other classes. The answer's unique unchangeable identifier." }, "content": { "value": "sample string", "description": "The respondent's selected answer content." }, "comment": { "value": "sample string", "description": "Optional text input provided by the respondent as an additional comment to the selected response." } } ] }, { "question_id": { "value": 0, "description": "The question's unique unchangeable identifier." }, "question_type": { "value": "single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat", "description": "The question's type" }, "answer": { "id": { "value": 0, "description": "An abstract entity to build other classes. The answer's unique unchangeable identifier." }, "content": { "value": "sample string", "description": "The respondent's selected answer content." }, "rating": { "value": 0, "description": "Numerical value representing the respondent's rating." } } }, { "question_id": { "value": 0, "description": "The question's unique unchangeable identifier." }, "question_type": { "value": "single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat", "description": "The question's type" }, "fields": [ { "type": { "value": "sample string", "description": "The type of field in the contact form, as chosen by the user through the Survicate interface." }, "content": { "value": "sample string", "description": "The respondent's input for a specific field." } } ] }, { "question_id": { "value": 0, "description": "The question's unique unchangeable identifier." }, "question_type": { "value": "single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat", "description": "The question's type" }, "answer": "sample string" }, { "question_id": { "value": 0, "description": "The question's unique unchangeable identifier." }, "question_type": { "value": "single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat", "description": "The question's type" }, "answer": { "content": { "value": "sample string", "description": "Numerical value of the Net Promoter Score (NPS) chosen by the respondent." }, "tag": { "value": "detractor | passive | promoter", "description": "This represents the NPS group associated with the score selected by the respondent. The options include:\n* detractor (score 0-6)\n* passive (score 7-8)\n* promoter (score 9-10)\n" } } }, { "question_id": { "value": 0, "description": "The question's unique unchangeable identifier." }, "question_type": { "value": "single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat", "description": "The question's type" }, "answers": [ { "id": { "value": 0, "description": "An abstract entity to build other classes. The answer's unique unchangeable identifier." }, "content": { "value": "sample string", "description": "The respondent's selected answer content." }, "score": { "value": "sample string", "description": "Label of the selected option in a matrix choice question." } } ] }, { "question_id": { "value": 0, "description": "The question's unique unchangeable identifier." }, "question_type": { "value": "single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat", "description": "The question's type" }, "answers": [ { "id": { "value": 0, "description": "An abstract entity to build other classes. The answer's unique unchangeable identifier." }, "content": { "value": "sample string", "description": "The respondent's selected answer content." }, "rank": { "value": 0, "description": "The selected position of the respondent's choice in the ranking question." } } ] }, { "question_id": { "value": 0, "description": "The question's unique unchangeable identifier." }, "question_type": { "value": "single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat", "description": "The question's type" }, "action_performed": true } ], "description": "An array of answers provided by the respondent for each specific question in the survey. Questions the respondent skipped are not included." }, "respondent": { "value": { "uuid": { "value": "sample string", "description": "A unique, unchangeable identifier for the respondent." }, "attributes": { "value": [ { "name": { "value": "order_id", "description": "The attribute's name, exactly as you passed it to Survicate." }, "value": { "value": "A-1024", "description": "The attribute's value, always returned as a string." } } ], "description": "The respondent's customer-defined attributes. Which names appear here depends on the endpoint's 'attributes[]' query parameter - see the endpoint descriptions. These are name/value pairs you passed to Survicate yourself; Survicate does not add attributes of its own, so a field such as 'survey_type' only appears here if you set it." } }, "description": "The respondent who submitted the response." }, "attributes": { "value": [ { "name": { "value": "order_id", "description": "The attribute's name, exactly as you passed it to Survicate." }, "value": { "value": "A-1024", "description": "The attribute's value, always returned as a string." } } ], "description": "Customer-defined attributes recorded with this specific response, as name/value pairs - for example campaign identifiers passed with the survey link. What is returned here depends on the endpoint: the response list returns only the names listed in the 'attributes[]' query parameter (empty when omitted), the single-response endpoint always returns all of them - see the endpoint descriptions. Attributes of the person are returned under 'respondent.attributes' instead. Native response fields (for example 'uuid', 'collected_at', 'url', 'device_type', 'operating_system' and 'language') are returned as top-level properties of the response, not as attributes." } } } ], "description": "Responses of the respondent." } } ``` ### Response 404 The requested respondent was not found.