Paywall Templates (Public)

List Paywall Templates

Changed on

Returns a list of globally-available paywall templates. Public endpoint — no authentication required. Filter by category.

get/v2/paywalls/templates

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/paywalls/templates
  • Auth
    none required

Query parameters

limitstring
starting_afterstring

Cursor for forward pagination - returns items after this template ID

ending_beforestring

Cursor for backward pagination - returns items before this template ID

categorystring

Filter by template category

Response

Success

object'list' required

Object type, always list

url'/v2/paywalls/templates' required

API endpoint URL for this list

has_moreboolean required

Whether there are more results available beyond this page

Changes

    • warning

      added the new credentials_missing enum value to the / response property for the response 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

      for the query request parameter category, the type was generalized from string to no type

    • info

      for the query request parameter ending_before, the type was generalized from string to no type

    • info

      for the query request parameter starting_after, the type was generalized from string to no type

    • 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 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 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 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_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_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 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 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_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 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 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_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 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

    This list may be incomplete.