WEweb2wave

List paywalls

Changed on
get/paywalls

Request

  • Base URL
    https://api.web2wave.com/api
  • URL
    https://api.web2wave.com/api/paywalls
  • Auth
    API key in header api_key

Query parameters

with_deletedboolean
summaryboolean

When true, each paywall row drops heavy fields (custom_css, custom_head_html, css_variables, analytics, plans, prices) so a long list still fits in one response. Call GET /paywalls/{id} for full details when needed.

include_pricesboolean

Only with summary=true. When true, each paywall row includes attached prices without loading heavy paywall content fields.

include_plansboolean

Only with summary=true. When true, each paywall row includes attached plan IDs without loading heavy paywall content fields.

pageinteger
per_pageinteger

Page size for paywall list. Default is 100. Use pagination metadata in the response to fetch all paywalls with prices in batches.

Headers

api_keystring required

Response

List of paywalls

successinteger

Example response

{
  "paywalls": [
    {
      "id": 210,
      "project_id": 78,
      "slug": "api-paywall",
      "name": "API Paywall",
      "payment_system": "stripe",
      "after_pay_redirect": {
        "id": 24757
      },
      "prices": [
        {
          "after_pay_redirect": {
            "id": 24757
          }
        }
      ],
      "source_data": "JSON"
    }
  ]
}

Changes

  • eb8b2d9124acRevision changes
    • info

      added the new optional query request parameter include_plans

    • info

      added the new optional query request parameter include_prices

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page

    • info

      added the optional property to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status