[BETA] Search surveys

Search the surveys of your school, archived ones included unless isArchived says otherwise. This read-only operation uses POST to carry the filters in its body: credentials holding only read access are served.

Filters are combined with AND; the values of each list are combined with OR, up to 100 each. Date ranges are inclusive ISO-8601 instants with an offset. Sorts apply in array order, then by ID ascending; a survey without a scheduled send date sorts first in ascending scheduledSendDate order and last in descending order.

recipientIds never matches an anonymous survey, whose recipients are not disclosed, and cannot be combined with isAnonymous: true. completionDate keeps the surveys with at least one answer completed in the range, whoever gave it.

Each survey has the shape GET /surveys returns, with the same include* options.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
filters
object

Filters, combined with AND

sort
array of objects
Defaults to [object Object]

Sorts applied in order, then by ID ascending. Default: createdAt descending

sort
string
enum
required
Allowed:
string
enum
required
Allowed:
number
Defaults to 1

Page number, from 1

number
Defaults to 50

Surveys per page (max 100)

boolean
Defaults to false

When true, fill the studentAnswers array of each survey. Without it the array is returned empty, which does not mean that nobody answered

boolean
Defaults to false

When true, include the surveyTemplate object of each survey

boolean
Defaults to false

When true, include the training object of each survey

boolean
Defaults to false

When true, include the course object of each survey

Responses

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