curl -X POST https://api.getversive.com/api/v1/interviews \
-H "Authorization: Bearer $VERSIVE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"study_id": "9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b",
"title": "Participant #1042",
"metadata": { "userId": "u_1042", "cohort": "churned-q2" }
}'
{
"id": "5c8e2f1a-7d4b-4e9c-a1f3-6b2d8c4e0a9f",
"title": "Participant #1042",
"study_id": "9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b",
"metadata": { "userId": "u_1042", "cohort": "churned-q2" },
"link": "https://getversive.com/s/9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b?vid=Xy3...",
"status": "open",
"created_at": "2026-07-13T10:30:00Z"
}
Interviews
Create interview
Create an interview and get a personal participant link
POST
/
interviews
curl -X POST https://api.getversive.com/api/v1/interviews \
-H "Authorization: Bearer $VERSIVE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"study_id": "9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b",
"title": "Participant #1042",
"metadata": { "userId": "u_1042", "cohort": "churned-q2" }
}'
{
"id": "5c8e2f1a-7d4b-4e9c-a1f3-6b2d8c4e0a9f",
"title": "Participant #1042",
"study_id": "9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b",
"metadata": { "userId": "u_1042", "cohort": "churned-q2" },
"link": "https://getversive.com/s/9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b?vid=Xy3...",
"status": "open",
"created_at": "2026-07-13T10:30:00Z"
}
Creates an interview for a study and returns a unique participant link. This is the main integration point for inviting participants from your own systems — each interview gets its own
vid token, so you can track exactly who responded.
string
required
The study to create the interview in.
object
Arbitrary key/value data stored with the interview (e.g. your internal user ID, cohort, source). Available in results, filters, and exports.
string
A label for the interview (e.g. the participant’s reference).
string
default:"English"
Currently only
English is accepted.Response
string
The interview ID.
string
The personal participant URL — send this to your participant.
string
The study.
string
Starts as
open.string | null
object
string
curl -X POST https://api.getversive.com/api/v1/interviews \
-H "Authorization: Bearer $VERSIVE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"study_id": "9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b",
"title": "Participant #1042",
"metadata": { "userId": "u_1042", "cohort": "churned-q2" }
}'
{
"id": "5c8e2f1a-7d4b-4e9c-a1f3-6b2d8c4e0a9f",
"title": "Participant #1042",
"study_id": "9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b",
"metadata": { "userId": "u_1042", "cohort": "churned-q2" },
"link": "https://getversive.com/s/9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b?vid=Xy3...",
"status": "open",
"created_at": "2026-07-13T10:30:00Z"
}