[BETA] Get surveys based on filter criterias

get

https://ext.edusign.fr/v3/surveys

Retrieve the surveys of your school. To filter by lists of IDs or by date ranges, or to sort the results, POST /surveys:search is better suited.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

number

Defaults to 1

Page number for pagination (min: 1)

limit

number

Defaults to 100

Number of items per page (max: 100)

string

Search in survey name and description

type

number

Filter by survey type

startDate

string

Filter surveys starting from this date (ISO format)

endDate

string

Filter surveys ending before this date (ISO format)

trainingId

string

Filter by training ID

completionDateFrom

date-time

Only surveys with at least one answer completed on or after this ISO 8601 datetime (timezone required, e.g. YYYY-MM-DDTHH:mm:ssZ)

completionDateTo

date-time

Only surveys with at least one answer completed on or before this ISO 8601 datetime (timezone required, e.g. YYYY-MM-DDTHH:mm:ssZ)

includeSurveyAnswers

boolean

Include survey answers

includeTraining

boolean

Include training

includeCourse

boolean

Include course

includeTemplate

boolean

Include template

filterAnonymous

boolean

Filter anonymous surveys

sentToRecipients

boolean

true: only surveys sent to at least one of their current recipients, by any channel (a send, a reminder or a scheduled send). false: only surveys sent to none of them, such as a survey answered without being sent. A recipient removed from the survey takes its sends with it. Unlike isSent, which only reports that a scheduled send ran.

Responses

200Success

400Bad Request

401Unauthorized

403Forbidden

429Too Many Requests

500Internal Server Error