Skip to main content
GET
/
v1
/
surveys
List surveys
curl --request GET \
  --url https://api.doozy.live/v1/surveys \
  --header 'x-api-key: <api-key>'
{
  "object": "list",
  "data": [
    {
      "object": "survey",
      "id": "survey_abc123",
      "title": "Employee Satisfaction Survey",
      "description": "Monthly check-in on team satisfaction",
      "mode": "survey",
      "response_type": "anonymous",
      "results_visibility": "owner",
      "status": "scheduled",
      "question_count": 5,
      "track": {
        "id": "wf_abc123",
        "name": "Onboarding Program"
      },
      "instances": [
        {
          "object": "survey_instance",
          "id": "inst_xyz789",
          "scheduled_at": "2026-01-15T10:30:00.000Z",
          "end_at": "2026-01-22T10:30:00.000Z",
          "total_recipients": 50,
          "total_responses": 35,
          "response_rate": 70,
          "track_instance_id": "wf_inst_abc123"
        }
      ],
      "created_at": "2026-01-15T10:30:00.000Z",
      "updated_at": "2026-01-20T14:00:00.000Z"
    }
  ],
  "has_more": true,
  "url": "/v1/surveys",
  "next_cursor": "survey_xyz789",
  "previous_cursor": "survey_abc123"
}

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"

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"