Skip to main content
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

EndpointMethodDescription
/studiesGETList studies and check interview capacity
/studies/:idGETGet study details, questions, and interview count
/interviewsGETList interviews for a study
/interviews/:idGETGet interview with full transcript
/releasesGETList releases for your project
/releases/:idGETGet release details and linked chat ID
/chatsGETList customer-visible chats for your project
/chats/:idGETGet chat metadata and visible message count
/webhooksPUT GET DELETEConfigure webhook notifications

​
Error handling

StatusMeaning
200Success
201Resource created
204Deleted successfully
400Invalid request body
401Missing or invalid API key
404Resource 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.