List Invitation Responses

Get all responses for a specific invitation, with optional status filtering, sorting and paging.

Rows for anonymous responses, and on an anonymous tracking link rows for contacts who have not responded yet, carry nothing that identifies the contact or leads to their response: id, response_id, opted_out, started_survey and ended_survey are left out, and name, email and ip_address are blank. Filtering by the opted-out status does not return these rows.

Sort with sort_by set to id, response_id, started_survey or ended_survey, followed by ,asc or ,desc; repeat it to break ties. Other keys are ignored and the default, id,asc, applies. Anonymous rows have none of these values, so every sort keeps them together as one group rather than placing them by their contact, their response or when they responded. They sort with the rows that have no value for the sort key, which come first in ascending order and last in descending order.

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

The survey id whose Invitation you are querying

int32
required

The invitation id whose responses you are querying

Query Params
int32
enum

Filter responses by status. Possible values: 0=All, 1=Sent, 2=Queued, 3=Completed, 4=Pending, 5=Failed, 6=Opened, 7=Viewed, 8=OptedOut, 9=Deleted

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
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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