HomeGuidesAPI Reference
API Reference
  1. SS Public API
  2. SurveyResponses

Get All

get
https://{host}/v2/surveys//responses

Gets all Responses with paging. If you are using the Organisation Hierarchy feature, each response recorded against an entity also carries entity_name, entity_unique_id and an entity object listing every entity field defined for your organisation with the value that applies to that entity, inherited from its parent entities where the entity itself holds none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The survey id whose Responses you are querying

Query Params
int32

The 1-based page number

int32

The number of results you want up to 100

sort_by
array of strings

Optional list of properties that you want to sort by

sort_by
int32
Defaults to 1

Whether to only include completed responses

int32
Defaults to 1

The translation for the results - defaults to English

int64
Defaults to 0

Unix timestamp to filter results after a date/time

int64
Defaults to 0

Unix timestamp to filter results before a date/time

int32
Defaults to 0

Optional filter id for the results

Tracking link id to filter results

string

Filter on the user unique id

boolean
Defaults to false

Whether to include question and page labels (reduces the size of the response)

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 4 months ago