---
title: "Retrieve Responses"
method: GET
path: "/v1/responses"
tags: ["V1"]
---

# Retrieve Responses

`GET /v1/responses`

Use this endpoint to retrieve responses from your studies. This endpoint allows you to retrieve up to 1000 responses at a time.

## Query parameters

- `start` integer
- `end` integer
- `cursor` string
- `limit` integer
- `sid` integer
- `with_snapshots` boolean
- `with_urls` boolean
- `with_meta` boolean
- `with_custom_metadata` boolean
- `with_deleted_responses` boolean

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `cursor` string
  - `data` object[]
    - `createdAt` string
    - `customMetadata` object — The custom metadata of your sprig survey. Only returned when with_custom_metadata is true
    - `deletedAt` string, nullable — Only returned when with_deleted_responses is true
    - `externalUserId` string, nullable
    - `meta` object — The metadata of your sprig survey. Only returned when with_meta is true
      - `browser` string
      - `client` object
        - `height` integer
        - `width` integer
      - `href` string
      - `language` string
      - `os` string
      - `screen` object
        - `height` integer
        - `width` integer
      - `userAgent` string
    - `questionId` number
    - `questionText` string
    - `questionType` string
    - `response` union — The response field can return multiple data types (string, integer, object, array, or null) depending on the question type. Please refer to the examples for more information.
      - string
      - integer
      - object
    - `responseGroupUid` string
    - `selectedIndexes` integer — The selectedIndexes field returns one of two data types depending on question type. For multiple choice questions, it returns an integer. For multiple select questions, it returns an array of integers. Please refer to the examples for more information.
    - `surveyId` number
    - `updatedAt` string
    - `url` string — The url of your sprig survey. Only returned when with_urls is true
    - `visitorId` number
    - `visitorSnapshot` object — The visitor event, attribute, event property data of a Sprig survey response. Only returned when with_snapshots is true
      - `attribtues` object
      - `eventProperties` object
      - `events` object
      - `responseGroupUid` string
      - `triggeringEvent` string
      - `visitorId` string
    - `visitorUuid` string

## Other responses

- `400` — Bad Request
- `403` — You may have an invalid or missing API key and you should check your authorization header. There is no message with this status code.
- `404` — Not Found
- `429` — Your application has made too many requests in too short a time.
- `500` — Something went wrong on Sprig's side. These are very rare :)

---

[API](https://skmtc.dev/sprig/apis/sprig-api.md) · [All operations](https://skmtc.dev/sprig/apis/sprig-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sprig/sprig-api/revisions/e415b6f55281/schema)