Surveys

List surveys

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

Required scopes: read 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

Query parameters

namestring

Return only surveys whose name contains this text (case-insensitive). A name that matches no survey returns an empty list.

page_sizeinteger

The number of surveys to return per page

pageinteger

Response

Successful response

nextstring nullable
previousstring nullable
countinteger

Example response

{
  "next": "https://api.simplesat.io/api/v1/surveys?page=2&page_size=10",
  "previous": null,
  "count": 25,
  "surveys": [
    {
      "id": 1,
      "name": "Follow-up CSAT Survey",
      "metric": "CSAT",
      "survey_token": "z_3OxYijnEkfZSt6hLKxCRxBlu4CPQ9feLUAW4Eaen4",
      "survey_type": "generic_embed",
      "brand_name": "Simplesat"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.