App Store Connect Configurations V25

App User Erasures V24

Application Webapp Origins V23

Assets V26

Audit Logs V22

Campaigns V234

Chart Annotations5

Charts V28

CLI Agent V22

Custom Store Events1

Custom Stores8

Demand Score V23

Entitlements V28

Events V24

Google Play V28

Grants V21

Imports1

Integration Event Names (Service)1

Me V25

Notifications1

Onboarding V21

get/v2/onboarding/contextGet Onboarding Context

Organization Access V211

Organizations V22

Paywall Resolver (Public)2

Paywall Templates (Public)1

Paywalls V217

Products V211

Project Auth V26

Project Transfers V27

Projects V224

Query V22

Retention Configurations V212

Retention Default Messages V29

Retention Messages V211

Retention Messaging Onboarding V28

retentionCampaignsV29

RevenueCat V1 (compatible)1

RevenueCat V2 (compatible)4

Stripe Customer Links V21

Surveys V212

Users V214

Users V34

Web2App Integrations V25

Webhooks V212

WorkOS Organization Admin1

Onboarding V2

Get Onboarding Context

Changed on Oct 29, 2026

Returns onboarding milestone booleans for the application. Requires onboarding:read scope.

get/v2/onboarding/context

Request

Base URL
https://api.superwall.com
URL
https://api.superwall.com/v2/onboarding/context
Auth
- HTTP bearer
- or API key in cookie accounts_superwall_token
- or HTTP bearer

Query parameters

application_idstring required

Response

Success

object'onboarding_context' required

sdk_installedboolean required

A session_start event has been received from the SDK

paywall_presentedboolean required

A paywall_open event has been received

transaction_completedboolean required

A transaction_complete event has been received (sandbox or production)

production_transaction_completedboolean required

A non-sandbox transaction_complete event has been received

products_createdboolean required

At least one product exists for the application

products_added_to_paywallboolean required

A paywall references a real (non-template) primary product

revenue_tracking_enabledboolean required

Revenue tracking is active for the application

onboarding_completedboolean required

Revenue tracking is enabled or a transaction has completed

latest_sdk_versionstring nullable required

Latest released SDK version tag for the application's platform (leading v stripped), or null if unknown/unavailable

Changes

Oct 29, 2026778a11cd2c15 Revision changes
- warning
  added the new credentials_missing enum value to the / response property for the response status
- warning
  added the new credentials_missing enum value to the / response property for the response status
- warning
  added the new credentials_missing enum value to the / response property for the response status
- warning
  added the new credentials_missing enum value to the / response property for the response status
- warning
  added the new credentials_missing enum value to the / response property for the response status
- info
  added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status
- info
  removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status
Sep 9, 2026217c96dc9a29 Revision changes
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from number to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- info
  added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status
- info
  added subschema #2 to the response body anyOf list for the response status
- info
  removed subschema #1: Missing API Key subschema #2: Invalid API Key Format subschema #3: Invalid API Key subschema #4: Authentication Failed subschema #5: Invalid Session from the response body anyOf list for the response status
- info
  removed subschema #2: Bad Request from the response body anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  added subschema #1 to the response property anyOf list for the response status
- info
  removed the api_error enum value from the response property for the response status
- info
  removed the api_error enum value from the response property for the response status
- info
  removed the api_error enum value from the response property for the response status
- info
  removed the api_error enum value from the response property for the response status
- info
  removed the authentication_error enum value from the response property for the response status
- info
  removed the authentication_error enum value from the response property for the response status
- info
  removed the authentication_error enum value from the response property for the response status
- info
  removed the authentication_error enum value from the response property for the response status
- info
  removed the authentication_failed enum value from the response property for the response status
- info
  removed the authentication_failed enum value from the response property for the response status
- info
  removed the authentication_failed enum value from the response property for the response status
- info
  removed the authentication_failed enum value from the response property for the response status
- info
  removed the idempotency_key_in_use enum value from the response property for the response status
- info
  removed the idempotency_key_in_use enum value from the response property for the response status
- info
  removed the idempotency_key_in_use enum value from the response property for the response status
- info
  removed the idempotency_key_in_use enum value from the response property for the response status
- info
  removed the insufficient_permissions enum value from the response property for the response status
- info
  removed the insufficient_permissions enum value from the response property for the response status
- info
  removed the insufficient_permissions enum value from the response property for the response status
- info
  removed the insufficient_permissions enum value from the response property for the response status
- info
  removed the internal_error enum value from the response property for the response status
- info
  removed the internal_error enum value from the response property for the response status
- info
  removed the internal_error enum value from the response property for the response status
- info
  removed the internal_error enum value from the response property for the response status
- info
  removed the invalid_api_key enum value from the response property for the response status
- info
  removed the invalid_api_key enum value from the response property for the response status
- info
  removed the invalid_api_key enum value from the response property for the response status
- info
  removed the invalid_api_key enum value from the response property for the response status
- info
  removed the invalid_api_key_format enum value from the response property for the response status
- info
  removed the invalid_api_key_format enum value from the response property for the response status
- info
  removed the invalid_api_key_format enum value from the response property for the response status
- info
  removed the invalid_api_key_format enum value from the response property for the response status
- info
  removed the invalid_reference enum value from the response property for the response status
- info
  removed the invalid_reference enum value from the response property for the response status
- info
  removed the invalid_reference enum value from the response property for the response status
- info
  removed the invalid_reference enum value from the response property for the response status
- info
  removed the invalid_request_error enum value from the response property for the response status
- info
  removed the invalid_request_error enum value from the response property for the response status
- info
  removed the invalid_request_error enum value from the response property for the response status
- info
  removed the invalid_request_error enum value from the response property for the response status
- info
  removed the invalid_session enum value from the response property for the response status
- info
  removed the invalid_session enum value from the response property for the response status
- info
  removed the invalid_session enum value from the response property for the response status
- info
  removed the invalid_session enum value from the response property for the response status
- info
  removed the missing_api_key enum value from the response property for the response status
- info
  removed the missing_api_key enum value from the response property for the response status
- info
  removed the missing_api_key enum value from the response property for the response status
- info
  removed the missing_api_key enum value from the response property for the response status
- info
  removed the organization_required enum value from the response property for the response status
- info
  removed the organization_required enum value from the response property for the response status
- info
  removed the organization_required enum value from the response property for the response status
- info
  removed the organization_required enum value from the response property for the response status
- info
  removed the parameter_invalid enum value from the response property for the response status
- info
  removed the parameter_invalid enum value from the response property for the response status
- info
  removed the parameter_invalid enum value from the response property for the response status
- info
  removed the parameter_invalid enum value from the response property for the response status
- info
  removed the parameter_missing enum value from the response property for the response status
- info
  removed the parameter_missing enum value from the response property for the response status
- info
  removed the parameter_missing enum value from the response property for the response status
- info
  removed the parameter_missing enum value from the response property for the response status
- info
  removed the parameter_unknown enum value from the response property for the response status
- info
  removed the parameter_unknown enum value from the response property for the response status
- info
  removed the parameter_unknown enum value from the response property for the response status
- info
  removed the parameter_unknown enum value from the response property for the response status
- info
  removed the permission_error enum value from the response property for the response status
- info
  removed the permission_error enum value from the response property for the response status
- info
  removed the permission_error enum value from the response property for the response status
- info
  removed the permission_error enum value from the response property for the response status
- info
  removed the rate_limit_error enum value from the response property for the response status
- info
  removed the rate_limit_error enum value from the response property for the response status
- info
  removed the rate_limit_error enum value from the response property for the response status
- info
  removed the rate_limit_error enum value from the response property for the response status
- info
  removed the rate_limit_exceeded enum value from the response property for the response status
- info
  removed the rate_limit_exceeded enum value from the response property for the response status
- info
  removed the rate_limit_exceeded enum value from the response property for the response status
- info
  removed the rate_limit_exceeded enum value from the response property for the response status
- info
  removed the resource_already_exists enum value from the response property for the response status
- info
  removed the resource_already_exists enum value from the response property for the response status
- info
  removed the resource_already_exists enum value from the response property for the response status
- info
  removed the resource_already_exists enum value from the response property for the response status
- info
  removed the resource_archived enum value from the response property for the response status
- info
  removed the resource_archived enum value from the response property for the response status
- info
  removed the resource_archived enum value from the response property for the response status
- info
  removed the resource_archived enum value from the response property for the response status
- info
  removed the resource_missing enum value from the response property for the response status
- info
  removed the resource_missing enum value from the response property for the response status
- info
  removed the resource_missing enum value from the response property for the response status
- info
  removed the resource_missing enum value from the response property for the response status
- info
  removed the side_effect_failed enum value from the response property for the response status
- info
  removed the side_effect_failed enum value from the response property for the response status
- info
  removed the side_effect_failed enum value from the response property for the response status
- info
  removed the side_effect_failed enum value from the response property for the response status
- info
  removed the unsupported_operation enum value from the response property for the response status
- info
  removed the unsupported_operation enum value from the response property for the response status
- info
  removed the unsupported_operation enum value from the response property for the response status
- info
  removed the unsupported_operation enum value from the response property for the response status
- info
  removed the upstream_service_error enum value from the response property for the response status
- info
  removed the upstream_service_error enum value from the response property for the response status
- info
  removed the upstream_service_error enum value from the response property for the response status
- info
  removed the upstream_service_error enum value from the response property for the response status
This list may be incomplete.

Operation history

Get Onboarding Context

Request

Query parameters

Response 200OK

Changes

Response