Skip to main content
GET
List surveys

Authorizations

x-api-key
string
header
required

API key for authentication. Generate keys in the Doozy dashboard.

Query Parameters

limit
integer
default:25

Maximum number of results to return (1-100, default 25)

Required range: 1 <= x <= 100
Example:

25

starting_after
string

Cursor for pagination - the ID of the last item from the previous page

Example:

"survey_abc123"

track_id
string

Filter surveys by track ID

Example:

"wf_abc123"

mode
enum<string>

Filter by survey mode (poll or survey)

Available options:
poll,
survey
Example:

"survey"

status
enum<string>

Filter by survey status. Default is 'scheduled' (active surveys only). Use 'archived' to return archived surveys.

Available options:
draft,
scheduled,
archived
Example:

"scheduled"

Response

List of surveys

object
enum<string>
required

String representing the object type

Available options:
list
Example:

"list"

data
object[]
required

Array of survey objects

has_more
boolean
required

Whether there are more results available beyond this page

Example:

true

url
string
required

The URL for accessing this list endpoint

Example:

"/v1/surveys"

next_cursor
string | null
required

Cursor to fetch the next page of results. Pass as starting_after in subsequent requests.

Example:

"survey_xyz789"

previous_cursor
string | null
required

Cursor to fetch the previous page of results. Pass as ending_before in subsequent requests.

Example:

"survey_abc123"