List surveys

GET

/surveys

const url = 'https://app.surveyrock.com/api/v1/surveys?limit=50&page=1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://app.surveyrock.com/api/v1/surveys?limit=50&page=1' \
  --header 'Authorization: Bearer <token>'

List surveys with pagination and tenant scoping. Supports both offset-based and cursor-based pagination for efficient traversal of large collections.

Authorizations

bearerAuth
surveys:read

Parameters

Query Parameters

limit

integer

default: 50 >= 1 <= 100

Number of results (1-100, default 50)

page

integer

default: 1 >= 1

Page number for offset pagination (default 1)

cursor

string

Cursor token for cursor-based pagination

Responses

200

List of surveys with pagination metadata

application/json

object

success

boolean

data

Array<object>

Survey basic information

object

Survey ID

string

>= 16 characters <= 16 characters

name

Survey name

string

description

Survey description

string

nullable

language

Survey language code

string

type

Survey type

integer

active

Survey status (0=inactive, 1=active)

integer

ownedAccountId

Owner account ID

string

>= 16 characters <= 16 characters

createdAt

string format: date-time

updatedAt

string format: date-time

pagination

object

total

integer

page

integer

limit

integer

totalPages

integer

hasMore

boolean

meta

Standard response metadata

object

timestamp

Response timestamp in ISO 8601 format

string format: date-time

version

API version

string

requestId

Unique request identifier

string

Example

{
  "success": true,
  "meta": {
    "version": "3.0"
  }
}

401

Unauthorized - invalid or missing token

application/json

Standard error response format

object

success

boolean

error

object

code

Stable, snake_case domain code – see ApiErrorHandler::EXCEPTION_MAP and DomainException

string

message

Human-readable error message

string

suggestion

Imperative recovery hint for this domain code – see ApiErrorHandler::DOMAIN_CODE_SUGGESTIONS

string

retryable

Whether retrying the identical request might succeed without any change on the caller’s end

boolean

details

Additional, code-specific error details

object

meta

Standard response metadata

object

timestamp

Response timestamp in ISO 8601 format

string format: date-time

version

API version

string

requestId

Unique request identifier

string

Example

{
  "success": false,
  "error": {
    "code": "survey_not_found"
  },
  "meta": {
    "version": "3.0"
  }
}

403

Forbidden - insufficient permissions

application/json

Standard error response format

object

success

boolean

error

object

code

Stable, snake_case domain code – see ApiErrorHandler::EXCEPTION_MAP and DomainException

string

message

Human-readable error message

string

suggestion

Imperative recovery hint for this domain code – see ApiErrorHandler::DOMAIN_CODE_SUGGESTIONS

string

retryable

Whether retrying the identical request might succeed without any change on the caller’s end

boolean

details

Additional, code-specific error details

object

meta

Standard response metadata

object

timestamp

Response timestamp in ISO 8601 format

string format: date-time

version

API version

string

requestId

Unique request identifier

string

Example

{
  "success": false,
  "error": {
    "code": "survey_not_found"
  },
  "meta": {
    "version": "3.0"
  }
}