GET
/api/v2/server-side-api/paywalls/ ペイウォール一覧を取得する
アプリのペイウォール一覧を取得します。
Query parameters
page[number]integer
ページネーションのページ番号
page[size]integer
1ページあたりのアイテム数
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 オブジェクトの配列
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 ステータスコード