> ## 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.

# API Overview

> Programmatic access to your userjourneys.ai project — manage studies, fetch interviews, inspect releases and chats, and configure webhooks.

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`](/api/studies)                              | `GET`                | List studies and check interview capacity         |
| [`/studies/:id`](/api/studies#get-v1studiesid)          | `GET`                | Get study details, questions, and interview count |
| [`/interviews`](/api/interviews)                        | `GET`                | List interviews for a study                       |
| [`/interviews/:id`](/api/interviews#get-v1interviewsid) | `GET`                | Get interview with full transcript                |
| [`/releases`](/api/releases)                            | `GET`                | List releases for your project                    |
| [`/releases/:id`](/api/releases#get-v1releasesid)       | `GET`                | Get release details and linked chat ID            |
| [`/chats`](/api/chats)                                  | `GET`                | List customer-visible chats for your project      |
| [`/chats/:id`](/api/chats#get-v1chatsid)                | `GET`                | Get chat metadata and visible message count       |
| [`/chats/:id/messages`](/api/chat-messages)             | `GET`                | List messages for a chat                          |
| [`/webhooks`](/api/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:

```json theme={null}
{
  "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.