List survey responses

GET

/response/surveys/{surveyId}

const url = 'https://app.surveyrock.com/api/v1/response/surveys/example?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/response/surveys/example?limit=50&page=1' \
  --header 'Authorization: Bearer <token>'

Get survey responses with streaming support for large datasets. Supports both offset-based and cursor-based pagination for efficient traversal.

Authorizations

bearerAuth
responses:read

Parameters

Path Parameters

surveyId

required

string

>= 16 characters <= 16 characters

Survey ID

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); ignored if cursor is provided

cursor

string

Cursor token for cursor-based pagination; takes precedence over page

Responses

200

List of survey responses with pagination metadata

application/json

object

success

boolean

data

Array<object>

object

responseId

string

respondentId

string

questionId

string

answer

Answer value (shape varies by question type)

nullable

submittedAt

string format: date-time

updatedAt

string format: date-time

respondent

object

startTime

string format: date-time

finishedTime

string format: date-time

nullable

distributorId

string

nullable

pagination

Total/page/limit/totalPages present when paginated by page; cursor_next present when paginated by cursor. hasMore is always present.

object

total

integer

nullable

page

integer

nullable

limit

integer

nullable

totalPages

integer

nullable

hasMore

boolean

cursor_next

string

nullable

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"
  }
}

400

Bad request - missing survey ID

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"
  }
}

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"
  }
}

404

Survey not found

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"
  }
}