Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.userjourneys.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Authorization
string
required
Bearer token. See Authentication.
​
limit
integer
Number of studies to return. Default 20, max 100.
​
starting_after
string
Cursor for pagination. Pass the id of the last study from the previous page.
curl https://app.userjourneys.ai/api/v1/studies \
  -H "Authorization: Bearer uj_live_your_key_here"

{
  "object": "list",
  "data": [
    {
      "id": "e5f6a7b8-1234-56cd-ef78-222222222222",
      "object": "study",
      "name": "Onboarding Feedback",
      "status": "active",
      "interview_link": "https://app.userjourneys.ai/i/xK9mR2pQ",
      "accepting_responses": true,
      "supported_languages": ["en", "es"],
      "limits": {
        "monthly": { "limit": 200, "used": 45 },
        "weekly": { "limit": 50, "used": 12 }
      },
      "created_at": "2026-03-01T00:00:00.000Z"
    }
  ],
  "has_more": false
}
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

​
Authorization
string
required
Bearer token. See Authentication.
​
id
string
required
Study ID (UUID).
curl https://app.userjourneys.ai/api/v1/studies/e5f6a7b8-1234-56cd-ef78-222222222222 \
  -H "Authorization: Bearer uj_live_your_key_here"

{
  "id": "e5f6a7b8-1234-56cd-ef78-222222222222",
  "object": "study",
  "name": "Onboarding Feedback",
  "status": "active",
  "interview_link": "https://app.userjourneys.ai/i/xK9mR2pQ",
  "accepting_responses": true,
  "supported_languages": ["en", "es"],
  "limits": {
    "monthly": { "limit": 200, "used": 45 },
    "weekly": { "limit": 50, "used": 12 }
  },
  "research_goal": "Understand user onboarding experience",
  "product_name": "Acme App",
  "questions": [
    { "text": "What was your first impression of the product?" },
    { "text": "What almost stopped you from signing up?" }
  ],
  "interview_count": 45,
  "created_at": "2026-03-01T00:00:00.000Z"
}
Returns 404 if the study doesn’t exist or doesn’t belong to your project.

​
Study object

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

​
Detail-only fields

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