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

Listar paywalls

Recupera una lista de paywalls de tu app.

Query parameters

page[number]integer

Número de página para la paginación

page[size]integer

Número de elementos por página

Responses

Paywalls recuperados correctamente

Schema
dataarray of objectrequired

Array de objetos de paywall

titlestringrequired

El nombre del paywall, tal como está definido en tu Adapty Dashboard

paywall_idstringrequired

El identificador único del paywall

use_paywall_builderbooleanrequired

Si el paywall utiliza el Paywall Builder

use_paywall_builder_legacybooleanrequired

Si el paywall utiliza el Paywall Builder heredado

updated_atstringrequired

Marca de tiempo de la última actualización del paywall

created_atstringrequired

Marca de tiempo de la creación del paywall

statestringrequired

El estado actual del paywall

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

is_deletedbooleanrequired

Si el paywall está marcado como eliminado

web_purchase_urlstring

URL para compras web, si corresponde

productsarray of objectrequired

Array de objetos de producto con información sobre los productos del paywall

product_idstringrequired

El identificador único del producto

titlestringrequired

El título del producto

product_setstringrequired

La categoría del conjunto de productos

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

offerobjectrequired
product_offer_idstringrequired

El identificador único de la oferta de producto

titlestringrequired

El título de la oferta

metaobjectrequired
paginationobjectrequired
countintegerrequired

Número total de paywalls

pageintegerrequired

Número de página actual

pagesintegerrequired

Número total de páginas

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

Solicitud incorrecta

Schema
errorsarray of objectrequired
sourcestring

Origen del error

errorsarray of string

Array de mensajes de error

error_codestringrequired

Nombre corto del error

status_codeintegerrequired

Código de estado HTTP

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

No autorizado

Schema
errorsarray of objectrequired
sourcestring

Origen del error

errorsarray of string

Array de mensajes de error

error_codestringrequired

Nombre corto del error

status_codeintegerrequired

Código de estado HTTP

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

Error interno del servidor

Schema
errorsarray of objectrequired
sourcestring

Origen del error

errorsarray of string

Array de mensajes de error

error_codestringrequired

Nombre corto del error

status_codeintegerrequired

Código de estado HTTP