Paywalls

Get paywall

Retrieves a specific paywall in your app.

get/api/v2/server-side-api/paywalls/{paywall_id}/

Request

  • Base URL
    https://api.adapty.io
  • URL
    https://api.adapty.io/api/v2/server-side-api/paywalls/{paywall_id}/
  • Auth
    API key in header Authorization

Path parameters

paywall_idstring uuid required

The unique identifier of the paywall to retrieve

Response

Paywall retrieved successfully

titlestring required

The name of the paywall, as defined in your Adapty Dashboard

paywall_idstring uuid required

The unique identifier of the paywall

use_paywall_builderboolean required

Whether the paywall uses the paywall builder

use_paywall_builder_legacyboolean required

Whether the paywall uses the legacy paywall builder

updated_atstring date-time required

Timestamp when the paywall was last updated

created_atstring date-time required

Timestamp when the paywall was created

state'draft' | 'live' | 'inactive' | 'archived' required

The current state of the paywall

is_deletedboolean required

Whether the paywall is marked as deleted

web_purchase_urlstring uri nullable

URL for web purchases, if applicable

Changes

No recorded changes to this operation across all 5 revisions of this API.