---
title: "Retrieve Surveys"
method: GET
path: "/v1/surveys"
tags: ["V1"]
---

# Retrieve Surveys

`GET /v1/surveys`

Studies were formerly surveys. This endpoint allows for the export of study configurations. The name will eventually change to Study, but at this time survey will be accepted anywhere study appears in the API. This endpoint allows you retrieve up to 1000 surveys at a time.

## Query parameters

- `start` integer
- `end` integer
- `cursor` string
- `status` string[]
- `limit` integer

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `cursor` string
  - `data` object[]
    - `completedAt` string
    - `constraints` object[]
      - `comparisonType` string
      - `event` unknown
      - `type` string
      - `value` number
    - `createdAt` string
    - `id` number
    - `launchedAt` unknown
    - `name` string
    - `platform` string
    - `questions` object[]
      - `id` number
      - `options` object[]
      - `optionsProperties` object, nullable
        - `introText` string
        - `labels` object
          - `left` string, required
          - `right` string, required
      - `questionText` string
      - `routingOptions` unknown
      - `type` string
    - `status` string
    - `totalResponseLimit` unknown
    - `type` string
    - `updatedAt` 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.
- `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)