Skip to main content
An interview is a single conversation between an AI interviewer and a respondent. Each interview belongs to a study.

GET /v1/interviews

List interviews for a study. Filter by status, reference ID, or quality score.

Request

string
required
Bearer token. See Authentication.
string
required
Study ID (UUID). Only interviews belonging to this study are returned.
string
Filter by status. Common values: "completed", "started".
string
Filter by the reference ID you passed via ?reference_id= on the interview link. Use this to find a specific user’s interview.
string
Filter by quality: "insightful", "successful", or "unsuccessful".
integer
Number of interviews to return. Default 20, max 100.
string
Cursor for pagination. Pass the id of the last interview from the previous page.
Filter by reference_id to find a specific user’s interview: ?study_id=...&reference_id=user_12345

GET /v1/interviews/:id

Retrieve a single interview with the full transcript and structured question answers.

Request

string
required
Bearer token. See Authentication.
string
required
Interview ID (UUID). This is the interview_id from the webhook payload.
Returns 404 if the interview doesn’t exist or doesn’t belong to your project.

Interview object

string
Interview ID (UUID).
string
"interview"
string
The study this interview belongs to.
string
"completed", "started", or "processing".
string | null
Custom identifier passed via ?reference_id= on the interview link.
string | null
Email entered during or after the interview. null if not collected.
string | null
Detected language code (e.g. "en", "es", "de").
string | null
"insightful", "successful", or "unsuccessful".
integer | null
Interview length in seconds.
string | null
AI-generated one-line summary.
string | null
AI-generated paragraph summary.
string
Interview start time (ISO 8601).
string | null
Interview end time (ISO 8601).
string
Record creation time (ISO 8601).

Detail-only fields

These fields are only included in GET /v1/interviews/:id responses:
object[]
Full conversation transcript, ordered chronologically.
object[]
Structured answers extracted from the transcript, one per interview question.