Sign in
Paywalls V2

Retrieve Paywall

Retrieves a paywall by ID. Requires paywalls:read scope.

get/v2/paywalls/{id}

Path parameters

idstring required

Paywall ID

Paywall ID

Response

Success

idstring required

Unique identifier for the paywall

object'paywall' required

Object type, always paywall

application_idstring required

ID of the application this paywall belongs to

project_idstring nullable required

a string to be decoded into a number

namestring required

Display name of the paywall

identifierstring required

URL-safe identifier (slug) for the paywall

paywall_urlstring required

URL to the interactive paywall

versionnumber required

Current published version number

headlessboolean required

Whether this is a code-first (headless) paywall, authored with the superwall framework and shipped with superwall push / superwall promote rather than the visual editor. A headless paywall with version: 0 has been pushed but never promoted, so it has no live snapshot and cannot back a campaign variant.

source_templatestring nullable required

a string to be decoded into a number

created_atstring required

ISO 8601 timestamp of when the paywall was created

updated_atstring required

ISO 8601 timestamp of when the paywall was last updated

published_atstring nullable required

ISO 8601 timestamp of when the paywall was last published, or null

archivedboolean required

Whether the paywall is archived

metadataobject required
preview_urlstring nullable required

URL to a preview screenshot of the paywall, or null

Changes