Superwall Onboarding V2 API
Onboarding milestone state for an application. Read-only; aggregates SDK events, product, and paywall signals for the dashboard quickstart guide.
Onboarding milestone state for an application. Read-only; aggregates SDK events, product, and paywall signals for the dashboard quickstart guide.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/superwall:superwall-onboarding-v2-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Superwall API V2 Onboarding V2 API
version: 2.0.0
description: Superwall V2 API - Scope-based authentication with organization API keys
servers:
- url: https://api.superwall.com
description: Production
- url: https://api.superwall.dev
description: Staging
- url: /
description: Local
security: []
tags:
- name: Onboarding V2
description: Onboarding milestone state for an application. Read-only; aggregates SDK events, product, and paywall signals for the dashboard quickstart guide.
paths:
/v2/onboarding/context:
get:
tags:
- Onboarding V2
operationId: onboardingv2.getOnboardingContext
parameters:
- name: application_id
in: query
schema:
type: string
required: true
security:
- bearer: []
- cookie: []
- oauth: []
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
object:
type: string
enum:
- onboarding_context
sdk_installed:
type: boolean
description: A `session_start` event has been received from the SDK
paywall_presented:
type: boolean
description: A `paywall_open` event has been received
transaction_completed:
type: boolean
description: A `transaction_complete` event has been received (sandbox or production)
production_transaction_completed:
type: boolean
description: A non-sandbox `transaction_complete` event has been received
products_created:
type: boolean
description: At least one product exists for the application
products_added_to_paywall:
type: boolean
description: A paywall references a real (non-template) primary product
revenue_tracking_enabled:
type: boolean
description: Revenue tracking is active for the application
onboarding_completed:
type: boolean
description: Revenue tracking is enabled or a transaction has completed
latest_sdk_version:
anyOf:
- type: string
- type: 'null'
description: Latest released SDK version tag for the application's platform (leading `v` stripped), or null if unknown/unavailable
required:
- object
- sdk_installed
- paywall_presented
- transaction_completed
- production_transaction_completed
- products_created
- products_added_to_paywall
- revenue_tracking_enabled
- onboarding_completed
- latest_sdk_version
additionalProperties: false
'400':
description: The request did not match the expected schema | The request was invalid or malformed
content:
application/json:
schema:
anyOf:
- type: object
properties:
_tag:
type: string
enum:
- HttpApiDecodeError
issues:
type: array
items:
type: object
properties:
_tag:
type: string
enum:
- Type
- Missing
- Unexpected
- Forbidden
- Pointer
- Refinement
- Transformation
- Composite
path:
type: array
items:
anyOf:
- type: string
- type: number
- type: object
properties:
_tag:
type: string
enum:
- symbol
key:
type: string
required:
- _tag
- key
additionalProperties: false
message:
type: string
required:
- _tag
- path
- message
additionalProperties: false
message:
type: string
required:
- _tag
- issues
- message
additionalProperties: false
- type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/BadRequest'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
type: string
param:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
required:
- _tag
- code
- message
additionalProperties: false
'401':
description: No API key was provided in the request | The API key does not have a valid format | The API key is invalid or has been revoked | An error occurred while validating the API key | The session cookie is invalid or expired
content:
application/json:
schema:
anyOf:
- type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/MissingApiKey'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
required:
- _tag
additionalProperties: false
- type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/InvalidApiKeyFormat'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
required:
- _tag
additionalProperties: false
- type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/InvalidApiKey'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
required:
- _tag
additionalProperties: false
- type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/AuthenticationFailed'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
required:
- _tag
additionalProperties: false
- type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/InvalidSession'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
required:
- _tag
additionalProperties: false
'403':
description: The API key does not have permission to perform this action
content:
application/json:
schema:
type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/PermissionError'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
type: string
required_scope:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
required:
- _tag
- message
additionalProperties: false
'404':
description: The requested resource was not found
content:
application/json:
schema:
type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/ResourceNotFound'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
param:
anyOf:
- type: string
doc_url:
anyOf:
- type: string
resource_type:
anyOf:
- type: string
resource_id:
anyOf:
- type: string
required:
- _tag
additionalProperties: false
'429':
description: Too many requests have been made in a short period
content:
application/json:
schema:
type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/RateLimit'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
retry_after:
anyOf:
- type: number
required:
- _tag
additionalProperties: false
'500':
description: An unexpected error occurred on the server
content:
application/json:
schema:
type: object
properties:
_tag:
type: string
enum:
- '@superwall/api-schema/v2/errors/InternalError'
type:
anyOf:
- type: string
enum:
- api_error
- authentication_error
- invalid_request_error
- rate_limit_error
- permission_error
code:
anyOf:
- type: string
enum:
- resource_missing
- resource_already_exists
- resource_archived
- parameter_invalid
- parameter_missing
- parameter_unknown
- invalid_reference
- unsupported_operation
- idempotency_key_in_use
- rate_limit_exceeded
- invalid_api_key
- invalid_api_key_format
- missing_api_key
- authentication_failed
- invalid_session
- organization_required
- insufficient_permissions
- internal_error
- upstream_service_error
- side_effect_failed
message:
anyOf:
- type: string
cause:
anyOf:
- {}
required:
- _tag
additionalProperties: false
description: Returns onboarding milestone booleans for the application. Requires onboarding:read scope.
summary: Get Onboarding Context
components:
securitySchemes:
bearer:
type: http
scheme: Bearer
cookie:
type: apiKey
name: accounts_superwall_token
in: cookie
oauth:
type: http
scheme: Bearer