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.
Designed for agents and MCP
v4 was built with AI agents and the Model Context Protocol in mind. Every public resource in v4 is also exposed through the official Qonversion 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_aftercursors, 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.
Base URL
All v4 API requests should be made to:API Sections
| Section | Description |
|---|---|
| Users | Retrieve Qonversion users, manage user-level purchases, properties, and entitlements |
| User Properties | Manage user-level attributes for segmentation and analytics |
| Identities | Link Qonversion users to your own auth system IDs |
| Entitlements | Create entitlement definitions and grant / revoke access |
| Purchases | Inspect a user’s purchase history |
| Products | Manage products configured in the Qonversion dashboard |
| Offerings | Bundles of products shown to users in paywalls |
| Remote Configurations | Server-driven configuration payloads delivered to the SDK |
| Customers | Aggregated customer data, properties, permissions, and metrics |
| Segments | Dynamic and system segments of users |
| Experiments | Paywall / offering experiments, groups, and user assignment |
| Screens | No-code paywall screens — CRUD, publish, duplicate, analytics |
| Analytics | Charts, cards, cohorts, LTV, and insights |
| Exports | Asynchronous data exports (customers, events, purchases) |
| Events | Event catalog and event log entries |
| Scheduled Reports | Recurring reports sent to external destinations |
| Integrations | Third-party integrations configuration |
| Automations | Event-driven automations |
| Project Settings | Project-level configuration, secret, and store credentials |
Request Format
All requests must include:Authorizationheader with a Bearer token (see Authentication)Content-Type: application/jsonforPOST,PUT,PATCH,DELETErequests