Skip to content
EquiPay Engine Docs
Esc
navigateopen⌘Jpreview

List survey campaigns

Returns survey campaigns for the token’s organization. Requires surveys:read.

GET/surveys
Responses
200The organization's survey campaigns.
dataSurvey[]
Show properties
Array of Survey
surveyIdstring
titleobject
Show properties
svstring
enstring
statusstring
Allowed:draftscheduledactiveclosed
questionCountinteger
401Missing or invalid API key.
errorobject
Show properties
statusstring
messagestring
403The API key lacks the scope required for this route.
errorobject
Show properties
statusstring
messagestring
Request
curl -X GET "https://paygap-jaggeman.web.app/api/v1/surveys"
Response
{
  "data": [
    {
      "surveyId": "weekly_pulse",
      "title": {
        "sv": "Veckopuls",
        "en": "Weekly pulse"
      },
      "status": "active",
      "questionCount": 8
    }
  ]
}