Paycose Docs
Survey
GET/surveys

List Surveys

List all active surveys with pagination.

Returns surveys with their ID, title, description, and question count.

Supports: ?limit=10&page=1 or ?use-cursor=true&starting_after=id

Requires: Bearer token, X-Country header.

Request

Example

curl -X GET 'https://api.paycose.com/api/v1/app1/platform/wallet/surveys/?limit=10&page=1&use-cursor=true&starting_after=&ending_before=&sort=created_at:desc&q=&filter[account_id]=&filter[created_at]=&filter[id]=&filter[status]=&filter[submitted_at]=&filter[survey_id]=&filter[updated_at]=' \
  -H 'X-Session-Token: {{session_token}}' \
  -H 'X-Country: {{country}}' \
  -H 'X-Test-Mode: {{x_test_mode}}'

Headers

NameValueDescription
X-Session-Token{{session_token}}
X-Country{{country}}
X-Test-Mode{{x_test_mode}}true=wallet_test, false=wallet_live (default). Toggle the x_test_mode collection variable to flip every applicable request.

Responses

200200 OK

Headers

NameValue
Content-Typeapplication/json

Body

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "status": "<string>",
      "version": 0,
      "question_count": 0
    }
  ],
  "page": 1,
  "limit": 10,
  "total_items": 1,
  "total_pages": 1
}

On this page