SUsuperwall
Paywalls V2

List Paywalls

Changed on

Returns a list of paywalls for the specified application. Requires paywalls:read scope. The application_id query parameter is required.

get/v2/paywalls

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/paywalls
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Query parameters

limitstring
starting_afterstring

Cursor for forward pagination - returns items after this paywall ID

ending_beforestring

Cursor for backward pagination - returns items before this paywall ID

application_idstring required
'draft'

Paywall is not active in any enabled campaign (inactive)

OR
'active'

Paywall is active in at least one enabled campaign

OR
'archived'

Paywall has been archived

archived'true' | 'false'
include_legacy_editor'true' | 'false'

Also return paywalls built in the legacy (pre-v4) editor, marked with legacy_editor (default: false)

exclude_global_templates'true' | 'false'

Leave out Superwall's public template paywalls, which are managed from the template gallery (default: false)

Response

Success

object'list' required

Object type, always list

url'/v2/paywalls' required

API endpoint URL for this list

has_moreboolean required

Whether there are more results available beyond this page

Changes

  • 523b4734dfabRevision changes
    • info

      added the optional property //// to the response with the status

  • 778a11cd2c15Revision 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