# Get paywall

> Retrieves a specific paywall in your app.

## OpenAPI

```yaml
/api-specs/adapty-api.yaml get /api/v2/server-side-api/paywalls/{paywall_id}/
openapi: 3.1.0
info:
  title: Adapty server-side API
  version: 1.0.0
servers:
  - url: https://api.adapty.io
    description: Production server
paths:
  /api/v2/server-side-api/paywalls/{paywall_id}/:
    get:
      summary: Get paywall
      description: Retrieves a specific paywall in your app.
      operationId: getPaywall
      tags:
        - Paywalls
      security:
        - apikeyAuth: []
      parameters:
        - name: paywall_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: The unique identifier of the paywall to retrieve
      responses:
        "200":
          description: Paywall retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PaywallResponse"
              example:
                title: Premium Subscription
                paywall_id: fd891d4f-5906-45b9-97c1-13cc3dc665df
                use_paywall_builder: true
                use_paywall_builder_legacy: false
                updated_at: "2025-07-30T11:13:58.798Z"
                created_at: "2025-07-30T11:13:58.798Z"
                state: live
                is_deleted: false
                web_purchase_url: https://example.com/purchase
                products:
                  - product_id: b95e9e51-a056-4eb6-9cf7-b75d139e7c3c
                    title: Premium Monthly
                    product_set: uncategorised
                    offer:
                      product_offer_id: e31a4296-f250-4faf-ac80-3cc93c2da8f5
                      title: Free Trial
                remote_configs:
                  - locale: en
                    data: "{\"title\":\"Premium Features\",\"subtitle\":\"Unlock all premium content\"}"
                main_screenshot:
                  image_id: 123456
                  url: https://public-media.adapty.io/public/screenshot.jpg
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                errors:
                  - Invalid API key
                error_code: unauthorized
                status_code: 401
        "404":
          description: Paywall not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                errors:
                  - source: null
                    errors:
                      - Paywall not found
                error_code: paywall_does_not_exist
                status_code: 404
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
components:
  schemas:
    PaywallResponse:
      type: object
      properties:
        title:
          type: string
          description: The name of the paywall, as defined in your Adapty Dashboard
        paywall_id:
          type: string
          format: uuid
          description: The unique identifier of the paywall
        use_paywall_builder:
          type: boolean
          description: Whether the paywall uses the paywall builder
        use_paywall_builder_legacy:
          type: boolean
          description: Whether the paywall uses the legacy paywall builder
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the paywall was last updated
        created_at:
          type: string
          format: date-time
          description: Timestamp when the paywall was created
        state:
          type: string
          enum:
            - draft
            - live
            - inactive
            - archived
          description: The current state of the paywall
        is_deleted:
          type: boolean
          description: Whether the paywall is marked as deleted
        web_purchase_url:
          type: string
          format: uri
          nullable: true
          description: URL for web purchases, if applicable
        products:
          type: array
          items:
            type: object
            properties:
              product_id:
                type: string
                format: uuid
                description: The unique identifier of the product
              title:
                type: string
                description: The title of the product
              product_set:
                type: string
                enum:
                  - weekly
                  - monthly
                  - trimonthly
                  - semiannual
                  - annual
                  - lifetime
                  - uncategorised
                  - nonsubscriptions
                  - two_months
                  - consumable
                description: The product set category
              offer:
                type: object
                nullable: true
                properties:
                  product_offer_id:
                    type: string
                    format: uuid
                    description: The unique identifier of the product offer
                  title:
                    type: string
                    description: The title of the offer
                required:
                  - product_offer_id
                  - title
            required:
              - product_id
              - title
              - product_set
              - offer
          description: Array of Product objects containing product information
        remote_configs:
          type: array
          items:
            type: object
            properties:
              locale:
                type: string
                description: The locale for the remote config
              data:
                type: string
                description: JSON string containing the remote config data
            required:
              - locale
              - data
          description: Array of RemoteConfig objects with locale and data
        main_screenshot:
          type: object
          nullable: true
          properties:
            image_id:
              type: integer
              description: The unique identifier of the image
            url:
              type: string
              format: uri
              description: The URL of the image
          required:
            - image_id
            - url
          description: Main screenshot object with image_id and url
      required:
        - title
        - paywall_id
        - use_paywall_builder
        - use_paywall_builder_legacy
        - updated_at
        - created_at
        - state
        - is_deleted
        - products
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              source:
                type: string
                nullable: true
                description: Source of the error
              errors:
                type: array
                items:
                  type: string
                description: Array of error messages
        error_code:
          type: string
          description: Short error name
        status_code:
          type: integer
          description: HTTP status code
      required:
        - errors
        - error_code
        - status_code
  securitySchemes:
    apikeyAuth:
      type: apiKey
      name: Authorization
      in: header
      default: Api-Key {Your secret API key}
      description: |
        API requests must be authenticated by your secret API key as the **Authorization** 
        header with the value `Api-Key {your_secret_api_key}`, for example, 
        `Api-Key secret_live_...`. Find this key in the Adapty Dashboard -> 
        **App Settings** -> **General** tab -> **API keys** section.
```