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

SectionDescription
UsersRetrieve Qonversion users, manage user-level purchases, properties, and entitlements
User PropertiesManage user-level attributes for segmentation and analytics
IdentitiesLink Qonversion users to your own auth system IDs
EntitlementsCreate entitlement definitions and grant / revoke access
PurchasesInspect a user’s purchase history
ProductsManage products configured in the Qonversion dashboard
OfferingsBundles of products shown to users in paywalls
Remote ConfigurationsServer-driven configuration payloads delivered to the SDK
CustomersAggregated customer data, properties, permissions, and metrics
SegmentsDynamic and system segments of users
ExperimentsPaywall / offering experiments, groups, and user assignment
ScreensNo-code paywall screens — CRUD, publish, duplicate, analytics
AnalyticsCharts, cards, cohorts, LTV, and insights
ExportsAsynchronous data exports (customers, events, purchases)
EventsEvent catalog and event log entries
Scheduled ReportsRecurring reports sent to external destinations
IntegrationsThird-party integrations configuration
AutomationsEvent-driven automations
Project SettingsProject-level configuration, secret, and store credentials

Request Format

All requests must include:
  • Authorization header with a Bearer token (see 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.