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

Lister les paywalls

Copy as Markdown

Récupère la liste des paywalls de votre application.

Query parameters

page[number]integer

Numéro de page pour la pagination

page[size]integer

Nombre d'éléments par page

Responses

Paywalls récupérés avec succès

Schema
dataarray of objectrequired

Tableau d'objets paywall

titlestringrequired

Le nom du paywall, tel que défini dans votre Adapty Dashboard

paywall_idstringrequired

L'identifiant unique du paywall

use_paywall_builderbooleanrequired

Indique si le paywall utilise le Paywall Builder

use_paywall_builder_legacybooleanrequired

Indique si le paywall utilise le Paywall Builder hérité

updated_atstringrequired

Horodatage de la dernière mise à jour du paywall

created_atstringrequired

Horodatage de la création du paywall

statestringrequired

L'état actuel du paywall

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

is_deletedbooleanrequired

Indique si le paywall est marqué comme supprimé

web_purchase_urlstring

URL pour les achats web, le cas échéant

productsarray of objectrequired

Tableau d'objets produit contenant les informations sur les produits du paywall

product_idstringrequired

L'identifiant unique du produit

titlestringrequired

Le titre du produit

product_setstringrequired

La catégorie d'ensemble de produits

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

offerobjectrequired
product_offer_idstringrequired

L'identifiant unique de l'offre de produit

titlestringrequired

Le titre de l'offre

metaobjectrequired
paginationobjectrequired
countintegerrequired

Nombre total de paywalls

pageintegerrequired

Numéro de la page actuelle

pagesintegerrequired

Nombre total de 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
    }
  }
}

Requête invalide

Schema
errorsarray of objectrequired
sourcestring

Source de l'erreur

errorsarray of string

Tableau de messages d'erreur

error_codestringrequired

Nom court de l'erreur

status_codeintegerrequired

Code de statut HTTP

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

Non autorisé

Schema
errorsarray of objectrequired
sourcestring

Source de l'erreur

errorsarray of string

Tableau de messages d'erreur

error_codestringrequired

Nom court de l'erreur

status_codeintegerrequired

Code de statut HTTP

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

Erreur interne du serveur

Schema
errorsarray of objectrequired
sourcestring

Source de l'erreur

errorsarray of string

Tableau de messages d'erreur

error_codestringrequired

Nom court de l'erreur

status_codeintegerrequired

Code de statut HTTP