API reference

Base URL: https://surveyee.com/api/v1. Every request needs an Authorization: Bearer header.

Generated from the same OpenAPI spec served to tooling — this page and that file can never drift apart.

GET /surveys

List surveys

Parameters
page query · integer
limit query · integer
Responses
200 Paginated list of surveys401 Invalid or missing API key403 Plan does not include API access429 Rate limit exceeded
POST /surveys

Create a survey

Requires a JSON request body.
Responses
201 Created400 Validation error401 Invalid or missing API key403 Plan does not include API access429 Rate limit exceeded
GET /surveys/{id}

Get a survey

Parameters
id path · string · required
Responses
200 Survey object401 Invalid or missing API key403 Forbidden404 Survey not found429 Rate limit exceeded
GET /surveys/{id}/responses

List responses

Parameters
id path · string · required
page query · integer
limit query · integer
Responses
200 Paginated list of response metadata401 Invalid or missing API key403 Forbidden404 Survey not found429 Rate limit exceeded
POST /surveys/{id}/close

Close a survey

Parameters
id path · string · required
Responses
200 Survey closed401 Invalid or missing API key403 Forbidden404 Survey not found429 Rate limit exceeded