---
title: Response
description: >-
  Responses are the answers submitted by respondents to a specific survey. Each
  response is associated with a particular survey and respondent.
source_url:
  html: 'https://developers.survicate.com/data-export/response/'
  md: 'https://developers.survicate.com/data-export/response.md'
---
# Response

Responses are the answers submitted by respondents to a specific survey. Each response is associated with a particular survey and respondent. This section of the API enables you to access responses collected for each survey, as well as filter and export them for further analysis.

## List all responses

GET /surveys/{survey_id}/responses

Fetches the list of responses for a specific survey identified by its unique ID.

### Required parameters

Name: survey_id
Type: string
Description: The unique identifier of the survey containing the responses.

### 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: filters
Type: array
Description: Apply specific filters to narrow down the results. This parameter accepts an array of filter objects, where each filter can be based on different criteria such as operating system, device type, platform, survey translation language, URL, custom attribute, or question answer. Use the appropriate filter schema from the available options, including OsFilter, DeviceFilter, PlatformFilter, TranslationFilter, UrlFilter, CustomAttributeFilter, or QuestionAnswerFilter, to define the desired filtering conditions.

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.

Name: end
Type: string
Description: Optional older bound of the time range. Responses are ordered from latest to oldest, so 'end' is the earlier of the two timestamps: responses collected at or after it are included (inclusive). Because of the ordering, 'end' must be earlier than 'start'. The timestamp should be in the ISO 8601 format, including microseconds (e.g., '2023-01-01T00:00:00.000000Z').

Name: attributes[]
Type: array
Description: An optional list of attribute names to include in each response - repeat the parameter once per name, e.g. '?attributes[]=order_id&attributes[]=store'. When provided, matching attributes are included in both the response-level 'attributes' field and the 'respondent.attributes' field. When omitted, both fields are returned empty. Attribute names are the ones you defined yourself when passing the attributes to Survicate; there is no fixed set of names to choose from.

### Response 200

The operation was successful, and the list of responses for the requested survey 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].uuid
Type: string
Description: A unique, unchangeable identifier for the response.

Name: data[0].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].url
Type: string
Description: The URL where the survey was displayed to the respondent.

Name: data[0].device_type
Type: Desktop | Mobile | Tablet | Tv
Description: The type of device used by the respondent to submit the response.

Name: data[0].operating_system
Type: Android | OS | iOS | Linux | macOS | Windows | Other
Description: The operating system of the device used by the respondent.

Name: data[0].platform
Type: string
Description: The platform identifier of the device used by the respondent (e.g., 'MacIntel', 'Win32').

Name: data[0].language
Type: string
Description: If present, the language of the survey translation presented to the respondent.

Name: data[0].answers[0].question_id
Type: integer
Description: The question's unique unchangeable identifier.

Name: data[0].answers[0].question_type
Type: single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat
Description: The question's type

Name: data[0].answers[0].answer.id
Type: integer
Description: An abstract entity to build other classes. The answer's unique unchangeable identifier.

Name: data[0].answers[0].answer.content
Type: string
Description: The respondent's selected answer content.

Name: data[0].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].answers[0].answers[0].id
Type: integer
Description: An abstract entity to build other classes. The answer's unique unchangeable identifier.

Name: data[0].answers[0].answers[0].content
Type: string
Description: The respondent's selected answer content.

Name: data[0].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].answers[0].answer.rating
Type: integer
Description: Numerical value representing the respondent's rating.

Name: data[0].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].answers[0].fields[0].content
Type: string
Description: The respondent's input for a specific field.

Name: data[0].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].answers[0].answers[0].score
Type: string
Description: Label of the selected option in a matrix choice question.

Name: data[0].answers[0].answers[0].rank
Type: integer
Description: The selected position of the respondent's choice in the ranking question.

Name: data[0].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].respondent.uuid
Type: string
Description: A unique, unchangeable identifier for the respondent.

Name: data[0].respondent.attributes[0].name
Type: string
Description: The attribute's name, exactly as you passed it to Survicate.

Name: data[0].respondent.attributes[0].value
Type: string
Description: The attribute's value, always returned as a string.

Name: data[0].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].attributes[0].name
Type: string
Description: The attribute's name, exactly as you passed it to Survicate.

Name: data[0].attributes[0].value
Type: string
Description: The attribute's value, always returned as a string.

Name: data[0].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.

```json
{
  "pagination_data": {
    "has_more": {
      "value": true,
      "description": "Specifies if additional pages are available for retrieval (True or False)."
    },
    "next_url": {
      "value": "/surveys/69f3dcf0d3220de7/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": [
    {
      "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."
      }
    }
  ]
}
```

### Response 404

The specified survey could not be found.

---

## Retrieve a response

GET /surveys/{survey_id}/responses/{response_uuid}

Fetches the details of a single response for a given survey, including the survey information, respondent details, response collection timestamp, device and operating system, language, answers to the survey questions, and any custom attributes associated with the response.

### Required parameters

Name: survey_id
Type: string
Description: The unique identifier of the survey containing the response.

Name: response_uuid
Type: string
Description: The unique identifier (UUID) of the response to be retrieved.

### Optional parameters

Name: attributes[]
Type: array
Description: An optional list of respondent attribute names to include under 'respondent.attributes' - repeat the parameter once per name, e.g. '?attributes[]=order_id&attributes[]=store'. When omitted, 'respondent.attributes' is returned empty. Unlike on the response list endpoint, the response-level 'attributes' field is always returned in full here, regardless of this parameter.

### Response 200

The operation was successful, and the details of the requested response have been returned.

#### Response properties

Name: uuid
Type: string
Description: A unique, unchangeable identifier for the response.

Name: 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: url
Type: string
Description: The URL where the survey was displayed to the respondent.

Name: device_type
Type: Desktop | Mobile | Tablet | Tv
Description: The type of device used by the respondent to submit the response.

Name: operating_system
Type: Android | OS | iOS | Linux | macOS | Windows | Other
Description: The operating system of the device used by the respondent.

Name: platform
Type: string
Description: The platform identifier of the device used by the respondent (e.g., 'MacIntel', 'Win32').

Name: language
Type: string
Description: If present, the language of the survey translation presented to the respondent.

Name: answers[0].question_id
Type: integer
Description: The question's unique unchangeable identifier.

Name: answers[0].question_type
Type: single | multiple | dropdown_list | rating | ranking | smiley_scale | numerical_scale | csat
Description: The question's type

Name: answers[0].answer.id
Type: integer
Description: An abstract entity to build other classes. The answer's unique unchangeable identifier.

Name: answers[0].answer.content
Type: string
Description: The respondent's selected answer content.

Name: answers[0].answer.comment
Type: string
Description: Optional text input provided by the respondent as an additional comment to the selected response.

Name: answers[0].answers[0].id
Type: integer
Description: An abstract entity to build other classes. The answer's unique unchangeable identifier.

Name: answers[0].answers[0].content
Type: string
Description: The respondent's selected answer content.

Name: answers[0].answers[0].comment
Type: string
Description: Optional text input provided by the respondent as an additional comment to the selected response.

Name: answers[0].answer.rating
Type: integer
Description: Numerical value representing the respondent's rating.

Name: 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: answers[0].fields[0].content
Type: string
Description: The respondent's input for a specific field.

Name: 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: answers[0].answers[0].score
Type: string
Description: Label of the selected option in a matrix choice question.

Name: answers[0].answers[0].rank
Type: integer
Description: The selected position of the respondent's choice in the ranking question.

Name: 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: respondent.uuid
Type: string
Description: A unique, unchangeable identifier for the respondent.

Name: respondent.attributes[0].name
Type: string
Description: The attribute's name, exactly as you passed it to Survicate.

Name: respondent.attributes[0].value
Type: string
Description: The attribute's value, always returned as a string.

Name: 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: attributes[0].name
Type: string
Description: The attribute's name, exactly as you passed it to Survicate.

Name: attributes[0].value
Type: string
Description: The attribute's value, always returned as a string.

Name: 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.

```json
{
  "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."
  }
}
```

### Response 404

The specified response or survey could not be found.

