Superwall Paywall Templates (Public) API

openapi: 3.2.0
info:
  title: Superwall API V2 Paywall Templates (Public) API
  version: 2.0.0
  description: Superwall V2 API - Scope-based authentication with organization API keys
servers:
- url: https://api.superwall.com
  description: Production
- url: https://api.superwall.dev
  description: Staging
- url: /
  description: Local
security: []
tags:
- name: Paywall Templates (Public)
  description: Browse the global paywall template catalog. This endpoint is public and returns only globally-available templates.
paths:
  /v2/paywalls/templates:
    get:
      tags:
      - Paywall Templates (Public)
      operationId: paywalltemplatesv2.listTemplates
      parameters:
      - name: limit
        in: query
        schema:
          anyOf:
          - type: string
        required: false
      - name: starting_after
        in: query
        schema:
          anyOf:
          - type: string
          description: Cursor for forward pagination - returns items after this template ID
        required: false
      - name: ending_before
        in: query
        schema:
          anyOf:
          - type: string
          description: Cursor for backward pagination - returns items before this template ID
        required: false
      - name: category
        in: query
        schema:
          anyOf:
          - type: string
          description: Filter by template category
        required: false
      security: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                    - list
                    description: Object type, always `list`
                  url:
                    type: string
                    enum:
                    - /v2/paywalls/templates
                    description: API endpoint URL for this list
                  has_more:
                    type: boolean
                    description: Whether there are more results available beyond this page
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        object:
                          type: string
                          enum:
                          - paywall_template
                          description: Object type, always `paywall_template`
                        application_id:
                          type: string
                        name:
                          type: string
                          description: Display name of the template
                        description:
                          anyOf:
                          - type: string
                          - type: 'null'
                          description: Description of the template, or null
                        paywall_url:
                          type: string
                          description: URL to the interactive template paywall
                        categories:
                          type: array
                          items:
                            type: string
                          description: Categories this template belongs to
                        preview_url:
                          anyOf:
                          - type: string
                          - type: 'null'
                          description: URL to preview the template, or null
                        visibility:
                          anyOf:
                          - type: string
                            enum:
                            - public
                            description: Visible to all organizations
                          - type: string
                            enum:
                            - organization
                            description: Visible only to the owning organization
                          description: Visibility scope of the template
                        presentation_style:
                          anyOf:
                          - type: string
                            enum:
                            - fullscreen
                            description: Full screen presentation
                          - type: string
                            enum:
                            - modal
                            description: Modal presentation
                          - type: string
                            enum:
                            - sheet
                            description: Bottom sheet presentation
                          - type: string
                            enum:
                            - push
                            description: Push navigation presentation
                          description: Default presentation style of the template
                        created_at:
                          type: string
                          description: ISO 8601 timestamp of when the template was created
                        updated_at:
                          type: string
                          description: ISO 8601 timestamp of when the template was last updated
                      required:
                      - id
                      - object
                      - application_id
                      - name
                      - description
                      - paywall_url
                      - categories
                      - preview_url
                      - visibility
                      - presentation_style
                      - created_at
                      - updated_at
                      additionalProperties: false
                    description: List of results
                required:
                - object
                - url
                - has_more
                - data
                additionalProperties: false
        '400':
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  _tag:
                    type: string
                    enum:
                    - HttpApiDecodeError
                  issues:
                    type: array
                    items:
                      type: object
                      properties:
                        _tag:
                          type: string
                          enum:
                          - Type
                          - Missing
                          - Unexpected
                          - Forbidden
                          - Pointer
                          - Refinement
                          - Transformation
                          - Composite
                        path:
                          type: array
                          items:
                            anyOf:
                            - type: string
                            - type: number
                            - type: object
                              properties:
                                _tag:
                                  type: string
                                  enum:
                                  - symbol
                                key:
                                  type: string
                              required:
                              - _tag
                              - key
                              additionalProperties: false
                        message:
                          type: string
                      required:
                      - _tag
                      - path
                      - message
                      additionalProperties: false
                  message:
                    type: string
                required:
                - _tag
                - issues
                - message
                additionalProperties: false
        '500':
          description: An unexpected error occurred on the server
          content:
            application/json:
              schema:
                type: object
                properties:
                  _tag:
                    type: string
                    enum:
                    - '@superwall/api-schema/v2/errors/InternalError'
                  type:
                    anyOf:
                    - type: string
                      enum:
                      - api_error
                      - authentication_error
                      - invalid_request_error
                      - rate_limit_error
                      - permission_error
                  code:
                    anyOf:
                    - type: string
                      enum:
                      - resource_missing
                      - resource_already_exists
                      - resource_archived
                      - parameter_invalid
                      - parameter_missing
                      - parameter_unknown
                      - invalid_reference
                      - unsupported_operation
                      - idempotency_key_in_use
                      - rate_limit_exceeded
                      - invalid_api_key
                      - invalid_api_key_format
                      - missing_api_key
                      - authentication_failed
                      - invalid_session
                      - organization_required
                      - insufficient_permissions
                      - internal_error
                      - upstream_service_error
                      - side_effect_failed
                  message:
                    anyOf:
                    - type: string
                  cause:
                    anyOf:
                    - {}
                required:
                - _tag
                additionalProperties: false
      description: Returns a list of globally-available paywall templates. Public endpoint — no authentication required. Filter by category.
      summary: List Paywall Templates
components:
  securitySchemes:
    bearer:
      type: http
      scheme: Bearer
    cookie:
      type: apiKey
      name: accounts_superwall_token
      in: cookie
    oauth:
      type: http
      scheme: Bearer