---
title: "List Survey Responses"
method: GET
path: "/surveys/{surveyId}/responses"
tags: ["surveys"]
---

# List Survey Responses

`GET /surveys/{surveyId}/responses`

## Request

- Base URL: `https://api.okendo.io/enterprise`
- URL: `https://api.okendo.io/enterprise/surveys/{surveyId}/responses`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/okendo/apis/okendo-enterprise-api/docs/surveys/:surveyId/responses/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of Survey Responses for the requested survey

## Path parameters

- `surveyId` string, uuid, required

## Query parameters

- `limit` integer
- `lastEvaluated` string
- `orderBy` string

## Response `200`

An object containing a list of Survey Responses and a relative link to the next page of results if available.

- object
  - `surveyResponses` object[]
    - `subscriberId` string, uuid, required: Your user ID within Okendo.
    - `surveyResponseId` string, uuid, required
    - `surveyId` string, uuid, required
    - `surveyName` string, required: The name of the survey.
    - `channelSurveyId` string, uuid, required
    - `channelSurveyDescription` string: The description of the channel survey.
    - `channel` 'on-site' | 'post-checkout' | 'post-review' | 'shareable-link', required: The channel through which the survey was submitted.
    - `answeredQuestions` union[], required
      - union
        - object
          - `id` string, uuid, required
          - `text` string, required: The question text.
          - `type` 'text', required
          - `answer` string
        - object
          - `id` string, uuid, required
          - `text` string, required: The question text.
          - `type` 'single-select', required
          - `answer` string, required
          - `customAnswer` string: Custom answer text provided by the respondent.
          - `customAnswerOptionText` string: Text for the custom answer option.
        - object
          - `id` string, uuid, required
          - `text` string, required: The question text.
          - `type` 'multi-select', required
          - `answer` string[], required
          - `customAnswer` string: Custom answer text provided by the respondent.
          - `customAnswerOptionText` string: Text for the custom answer option.
        - object
          - `id` string, uuid, required
          - `text` string, required: The question text.
          - `type` 'five-point' | 'star', required
          - `answer` number, required
        - object
          - `id` string, uuid, required
          - `text` string, required: The question text.
          - `type` 'nps', required
          - `answer` number, required
          - `answerNpsCategory` 'promoter' | 'detractor' | 'passive', required
        - object
          - `id` string, uuid, required
          - `text` string, required: The question text.
          - `type` 'profile', required
          - `answer` union, required: The profile answer data provided.
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
          - `profileQuestionId` string, uuid, required
        - object
          - `id` string, uuid, required
          - `text` string, required: The question text.
          - `type` 'email', required
          - `answer` string, email, required
          - `marketingOptIn` boolean
    - `customer` object
      - `customerId` string, uuid
      - `email` string, email
    - `dateCreated` string, date-time, required
    - `emailMarketingOptIn` boolean: Whether the customer opted in to email marketing.
    - `isArchived` boolean: Whether the survey response has been archived.
    - `order` object
      - `remoteOrderId` string: The numeric order ID from Shopify.
    - `reward` object
      - `type` 'coupon', required
      - `description` string, required: Description of the reward.
      - `value` string, required: The coupon code or reward value.
  - `nextUrl` string, uri

## Other responses

- `400`: Invalid request parameters.
- `401`: Authentication credentials are missing or incorrect.
- `404`: The requested resource could not be found.

---

[API](https://skmtc.dev/okendo/apis/okendo-enterprise-api.md) - [All operations](https://skmtc.dev/okendo/apis/okendo-enterprise-api/llms.txt) - [OpenAPI document](https://skmtc.dev/okendo/apis/okendo-enterprise-api/revisions/dd4c80ed1613?raw)