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

列出付费墙

Copy as Markdown

检索您应用中的付费墙列表。

Query parameters

page[number]integer

分页页码

page[size]integer

每页条目数

Responses

付费墙获取成功

Schema
dataarray of objectrequired

付费墙对象数组

titlestringrequired

付费墙的名称，如在 Adapty 看板中定义的

paywall_idstringrequired

付费墙的唯一标识符

use_paywall_builderbooleanrequired

付费墙是否使用付费墙编辑工具

use_paywall_builder_legacybooleanrequired

付费墙是否使用旧版付费墙编辑工具

updated_atstringrequired

付费墙最后更新时间戳

created_atstringrequired

付费墙创建时间戳

statestringrequired

付费墙的当前状态

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

is_deletedbooleanrequired

付费墙是否已被标记为删除

web_purchase_urlstring

网页购买的 URL（如适用）

productsarray of objectrequired

包含付费墙产品信息的产品对象数组

product_idstringrequired

产品的唯一标识符

titlestringrequired

产品的标题

product_setstringrequired

产品集类别

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

offerobjectrequired
product_offer_idstringrequired

产品优惠的唯一标识符

titlestringrequired

优惠的标题

metaobjectrequired
paginationobjectrequired
countintegerrequired

付费墙总数

pageintegerrequired

当前页码

pagesintegerrequired

总页数

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
    }
  }
}

请求错误

Schema
errorsarray of objectrequired
sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码

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

未授权

Schema
errorsarray of objectrequired
sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码

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

服务器内部错误

Schema
errorsarray of objectrequired
sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码