---
title: "List surveys"
method: GET
path: "/api/v1/surveys"
tags: ["Surveys"]
---

# List surveys

`GET /api/v1/surveys`

## Request

- Base URL: `https://api.simplesat.io`
- URL: `https://api.simplesat.io/api/v1/surveys`
- Auth: API key in header `X-Simplesat-Token`

List active surveys, newest first. Archived surveys are not returned.

Required scopes: `read surveys`

## Query parameters

- `name` string
- `page_size` integer
- `page` integer

## Response `200`

Successful response

- object
  - `next` string, nullable
  - `previous` string, nullable
  - `count` integer
  - `surveys` object[]
    - `id` integer
    - `name` string
    - `metric` string
    - `survey_token` string
    - `survey_type` string
    - `brand_name` string

---

[API](https://skmtc.dev/simplesat/apis/simplesat-api-v1.md) · [All operations](https://skmtc.dev/simplesat/apis/simplesat-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/simplesat/apis/simplesat-api-v1/revisions/1c245425416b?raw)