English 中文TürkçeРусскийEspañol日本語Tiếng Việt
GET /api/v2/server-side-api/paywalls/

Danh sách paywall

Copy as Markdown

Truy xuất danh sách các paywall trong ứng dụng của bạn.

Query parameters

page[number]integer

Số trang để phân trang

page[size]integer

Số mục trên mỗi trang

Responses

Các paywall được truy xuất thành công

Schema
dataarray of objectrequired

Mảng các đối tượng paywall

titlestringrequired

Tên của paywall, được xác định trong Adapty Dashboard của bạn

paywall_idstringrequired

Định danh duy nhất của paywall

use_paywall_builderbooleanrequired

Liệu paywall có sử dụng Paywall Builder hay không

use_paywall_builder_legacybooleanrequired

Liệu paywall có sử dụng Paywall Builder kế thừa hay không

updated_atstringrequired

Dấu thời gian khi paywall được cập nhật lần cuối

created_atstringrequired

Dấu thời gian khi paywall được tạo

statestringrequired

Trạng thái hiện tại của paywall

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

is_deletedbooleanrequired

Liệu paywall có được đánh dấu là đã xóa hay không

web_purchase_urlstring

URL cho giao dịch mua trên web, nếu có

productsarray of objectrequired

Mảng các đối tượng sản phẩm chứa thông tin sản phẩm cho paywall

product_idstringrequired

Định danh duy nhất của sản phẩm

titlestringrequired

Tiêu đề của sản phẩm

product_setstringrequired

Danh mục bộ sản phẩm

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

offerobjectrequired
product_offer_idstringrequired

Định danh duy nhất của ưu đãi sản phẩm

titlestringrequired

Tiêu đề của ưu đãi

metaobjectrequired
paginationobjectrequired
countintegerrequired

Tổng số paywall

pageintegerrequired

Số trang hiện tại

pagesintegerrequired

Tổng số trang

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

Yêu cầu không hợp lệ

Schema
errorsarray of objectrequired
sourcestring

Nguồn gốc lỗi

errorsarray of string

Mảng thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

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

Không được phép

Schema
errorsarray of objectrequired
sourcestring

Nguồn gốc lỗi

errorsarray of string

Mảng thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

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

Lỗi máy chủ nội bộ

Schema
errorsarray of objectrequired
sourcestring

Nguồn gốc lỗi

errorsarray of string

Mảng thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP