API Overview

The userjourneys.ai API lets you programmatically access your project data — check study capacity, fetch interviews, inspect releases and chats, and receive real-time webhook notifications when interviews complete.

Base URL

https://app.userjourneys.ai/api/v1

Endpoints

Endpoint	Method	Description
`/studies`	`GET`	List studies and check interview capacity
`/studies/:id`	`GET`	Get study details, questions, and interview count
`/interviews`	`GET`	List interviews for a study
`/interviews/:id`	`GET`	Get interview with full transcript
`/releases`	`GET`	List releases for your project
`/releases/:id`	`GET`	Get release details and linked chat ID
`/chats`	`GET`	List customer-visible chats for your project
`/chats/:id`	`GET`	Get chat metadata and visible message count
`/chats/:id/messages`	`GET`	List messages for a chat
`/webhooks`	`PUT` `GET` `DELETE`	Configure webhook notifications

Error handling

Status	Meaning
`200`	Success
`201`	Resource created
`204`	Deleted successfully
`400`	Invalid request body
`401`	Missing or invalid API key
`404`	Resource not found

All responses return JSON (except 204).

Pagination

List endpoints return paginated results using cursor-based pagination:

{
  "object": "list",
  "data": [...],
  "has_more": true
}

Pass limit to control page size (default 20, max 100). When has_more is true, pass starting_after with the id of the last item to get the next page.

Getting Started

Interviews

React Native SDK

Integrations

AI Agent

Guides

API

Support

Base URL

Endpoints

Error handling

​Base URL

​Endpoints

​Error handling

​Pagination

Base URL

Endpoints

Error handling

Pagination