Skip to main content
A study is a research configuration: the questions, target audience, and settings for a set of interviews. Each study has a public interview link that you send to respondents.

GET /v1/studies

List all active studies for your project. Returns studies with their current usage and whether they’re accepting new responses.

Request

string
required
Bearer token. See Authentication.
integer
Number of studies to return. Default 20, max 100.
string
Cursor for pagination. Pass the id of the last study from the previous page.
Cache this response for a few minutes. Study capacity doesn’t change often, and caching avoids unnecessary API calls.

GET /v1/studies/:id

Retrieve a single study with full details including questions, research goal, and interview count.

Request

string
required
Bearer token. See Authentication.
string
required
Study ID (UUID).
Returns 404 if the study doesn’t exist or doesn’t belong to your project.

Study object

string
Study ID (UUID).
string
"study"
string
Display name.
string
"active", "paused", or "draft".
Public URL for respondents. Append ?reference_id=your_user_id to track who completes the interview.
boolean
true when the study is active and within all usage limits.
string[]
Language codes the study supports (e.g. ["en", "es"]).
object
string
ISO 8601 timestamp.

Detail-only fields

These fields are only included in GET /v1/studies/:id responses:
string | null
The research objective for this study.
string | null
The product being researched.
object[]
The interview questions.
integer
Total number of completed interviews for this study.