API ReferenceSurveys

List Surveys (POST)

List surveys requested by the user.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
created_bylist of stringsOptional
Filters for surveys created by any of these users.
created_dateobjectOptional
Provides ways to specify date ranges on objects.
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
limitintegerOptional
The maximum number of surveys to return. If not set, then the default is '50'.
modeenumOptional

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

Allowed values:
modified_dateobjectOptional
Provides ways to specify date ranges on objects.
namelist of stringsOptional

Filters for surveys by name(s).

sort_bylist of stringsOptional
Fields to sort the surveys by and the direction to sort them.

Response

Success.
surveyslist of objects
The list of the surveys.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors