> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.qonversion.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> The Qonversion REST API v4 consolidates customer, analytics, experiment, segment, and integration management with an agent-first design.

The Qonversion REST API v4 is the current generation of our public HTTP API. It consolidates everything that was previously scattered across v3 endpoints and adds first-class management of customers, analytics, experiments, segments, screens, integrations, automations, scheduled reports, exports, and project settings.

<Note>
  v4 is available alongside v3. Existing integrations on v3 keep working; migrate resource by resource when convenient. Each endpoint in the guides below is tagged **New** or **Updated** with a link back to its v3 counterpart.
</Note>

## Designed for agents and MCP

v4 was built with AI agents and the [Model Context Protocol](https://modelcontextprotocol.io) in mind. Every public resource in v4 is also exposed through the official **[Qonversion MCP server](/docs/mcp-server)**, so the same API surface is callable directly from Claude, ChatGPT, Cursor, and any other MCP-compatible client — without a custom wrapper.

Concretely, v4 follows a set of rules that make it safe and predictable for an agent to use:

* **Stable, verb-based operation IDs** (e.g., `v4CreateScreen`, `v4ListExperiments`) — MCP tools map 1-to-1 to operations.
* **Consistent resource-oriented URLs** — `/v4/{resource}` for collections, `/v4/{resource}/{id}` for items, sub-resources nested only one level deep.
* **Paginated lists** with uniform `limit` / `starting_after` cursors, so agents can iterate deterministically.
* **Idempotent mutations** where feasible (PUT, PATCH, and DELETE are safe to retry).
* **One token type over HTTP** — v4 public endpoints all authenticate with the project Secret Key; the MCP server uses OAuth 2.1 with per-tool scopes instead, so AI clients never handle the Secret Key directly.
* **Machine-readable errors** — every error includes `type`, `code`, and field-level details so an agent can self-correct without parsing prose.

If you're building an agentic workflow on top of Qonversion, prefer v4.

## Base URL

All v4 API requests should be made to:

```
https://api.qonversion.io/v4
```

## API Sections

| Section                                                      | Description                                                                                                                             |
| ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| [Users](/reference/v4/users)                                 | Retrieve Qonversion users, manage user-level purchases, properties, and entitlements                                                    |
| [User Properties](/reference/v4/user-properties)             | Manage user-level attributes for segmentation and analytics                                                                             |
| [Identities](/reference/v4/identities)                       | Link Qonversion users to your own auth system IDs                                                                                       |
| [Entitlements](/reference/v4/entitlements)                   | Create entitlement definitions and grant / revoke access                                                                                |
| [Purchases](/reference/v4/purchases)                         | Inspect a user's purchase history                                                                                                       |
| [Products](/reference/v4/products)                           | Manage products configured in the Qonversion dashboard                                                                                  |
| [Offerings](/reference/v4/offerings) *(legacy)*              | Bundles of products shown to users in paywalls. Legacy — use [Remote Configs](/reference/v4/remote-configurations) instead              |
| [Remote Configurations](/reference/v4/remote-configurations) | Server-driven configuration payloads delivered to the SDK                                                                               |
| [Customers](/reference/v4/customers)                         | Aggregated customer data, properties, permissions, and metrics                                                                          |
| [Segments](/reference/v4/segments)                           | Dynamic and system segments of users                                                                                                    |
| [Experiments](/reference/v4/experiments)                     | Paywall / offering experiments, groups, and user assignment                                                                             |
| [Screens](/reference/v4/screens) *(deprecated)*              | No-code paywall screens — CRUD, publish, duplicate, analytics. Deprecated — product surface removed, API for existing integrations only |
| [Analytics](/reference/v4/analytics)                         | Charts, cards, cohorts, LTV, and insights                                                                                               |
| [Exports](/reference/v4/exports)                             | Asynchronous data exports (customers, events, purchases)                                                                                |
| [Events](/reference/v4/events)                               | Event catalog                                                                                                                           |
| [Scheduled Reports](/reference/v4/scheduled-reports)         | Recurring reports sent to external destinations                                                                                         |
| [Integrations](/reference/v4/integrations)                   | Third-party integrations configuration                                                                                                  |
| [Automations](/reference/v4/automations) *(deprecated)*      | Event-driven automations. Deprecated — product surface removed, API for existing integrations only                                      |
| [Project Settings](/reference/v4/project-settings)           | Project-level configuration, secret, and store credentials                                                                              |

## Request Format

All requests must include:

* `Authorization` header with a Bearer token (see [Authentication](/reference/v4/authentication))
* `Content-Type: application/json` for `POST`, `PUT`, `PATCH`, `DELETE` requests

## Response Format

All responses are JSON-encoded. List endpoints return paginated results. Error responses follow a consistent [error format](/reference/v4/handling-api-errors).