GET /api/v2/server-side-api/paywalls/

List paywalls

Copy as Markdown

Retrieves a list of paywalls in your app.

Query parameters

page[number]integer

Page number for pagination

page[size]integer

Number of items per page

Responses

Paywalls retrieved successfully

Schema
dataarray of objectrequired

Array of paywall objects

titlestringrequired

The name of the paywall, as defined in your Adapty Dashboard

paywall_idstringrequired

The unique identifier of the paywall

use_paywall_builderbooleanrequired

Whether the paywall uses the paywall builder

use_paywall_builder_legacybooleanrequired

Whether the paywall uses the legacy paywall builder

updated_atstringrequired

Timestamp when the paywall was last updated

created_atstringrequired

Timestamp when the paywall was created

statestringrequired

The current state of the paywall

One of: "draft", "live", "inactive", "archived"

is_deletedbooleanrequired

Whether the paywall is marked as deleted

web_purchase_urlstring

URL for web purchases, if applicable

productsarray of objectrequired

Array of product objects containing product information for the paywall

product_idstringrequired

The unique identifier of the product

titlestringrequired

The title of the product

product_setstringrequired

The product set category

One of: "weekly", "monthly", "trimonthly", "semiannual", "annual", "lifetime", "uncategorised", "nonsubscriptions", "two_months", "consumable"

offerobjectrequired
product_offer_idstringrequired

The unique identifier of the product offer

titlestringrequired

The title of the offer

metaobjectrequired
paginationobjectrequired
countintegerrequired

Total number of paywalls

pageintegerrequired

Current page number

pagesintegerrequired

Total number of pages

Example 
{
  "data": [
    {
      "title": "LlkTlizT",
      "paywall_id": "fd891d4f-5906-45b9-97c1-13cc3dc665df",
      "use_paywall_builder": false,
      "use_paywall_builder_legacy": false,
      "updated_at": "2025-07-08T07:27:06.754527+00:00",
      "created_at": "2025-07-08T07:27:06.754541+00:00",
      "state": "live",
      "is_deleted": false,
      "web_purchase_url": null,
      "products": [
        {
          "product_id": "b95e9e51-a056-4eb6-9cf7-b75d139e7c3c",
          "title": "mFUQPcJQ",
          "product_set": "uncategorised",
          "offer": null
        }
      ]
    },
    {
      "title": "Premium Subscription",
      "paywall_id": "a1cf7850-1bb8-4151-8336-a4e588730c55",
      "use_paywall_builder": true,
      "use_paywall_builder_legacy": false,
      "updated_at": "2025-07-28T08:15:13.722680+00:00",
      "created_at": "2025-07-25T13:40:01.789853+00:00",
      "state": "live",
      "is_deleted": false,
      "web_purchase_url": "https://example.com/purchase",
      "products": [
        {
          "product_id": "b136422f-8153-402a-afbb-986929c68f6a",
          "title": "Premium Monthly",
          "product_set": "uncategorised",
          "offer": {
            "product_offer_id": "e31a4296-f250-4faf-ac80-3cc93c2da8f5",
            "title": "Free Trial"
          }
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "count": 365,
      "page": 1,
      "pages": 183
    }
  }
}

Bad request

Schema
errorsarray of objectrequired
sourcestring

Source of the error

errorsarray of string

Array of error messages

error_codestringrequired

Short error name

status_codeintegerrequired

HTTP status code

Example 
{
  "errors": [
    {
      "source": "page_size",
      "errors": [
        "Invalid page_size parameter. Must be between 1 and 100."
      ]
    }
  ],
  "error_code": "validation_error",
  "status_code": 400
}

Unauthorized

Schema
errorsarray of objectrequired
sourcestring

Source of the error

errorsarray of string

Array of error messages

error_codestringrequired

Short error name

status_codeintegerrequired

HTTP status code

Example 
{
  "errors": [
    "Invalid API key"
  ],
  "error_code": "unauthorized",
  "status_code": 401
}

Internal server error

Schema
errorsarray of objectrequired
sourcestring

Source of the error

errorsarray of string

Array of error messages

error_codestringrequired

Short error name

status_codeintegerrequired

HTTP status code