Skip to main content
GET
/
v1
/
paywalls
List paywalls
curl --request GET \
  --url https://api.myproceeds.xyz/v1/paywalls \
  --header 'X-Api-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "slug": "<string>",
      "name": "<string>",
      "description": "<string>",
      "targetUrl": "<string>",
      "routePattern": "<string>",
      "price": "<string>",
      "currency": "USDC",
      "network": "base-sepolia",
      "networks": [
        "base-sepolia"
      ],
      "merchantWallet": "<string>",
      "facilitatorUrl": "<string>",
      "timeout": 123,
      "validityWindow": 123,
      "allowedMethods": [],
      "enabled": true,
      "headers": [
        {
          "key": "<string>",
          "value": "***"
        }
      ],
      "queryParams": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "serviceId": "<string>",
      "userId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "requestId": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "total": 123,
      "limit": 123,
      "offset": 123,
      "hasMore": true
    }
  }
}

Authorizations

X-Api-Key
string
header
required

API key in format mpk_<64 hex chars>. Can alternatively be sent as Authorization: Bearer mpk_....

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
serviceId
string

Filter paywalls by parent service ID

enabled
enum<string>

Filter by enabled status

Available options:
true,
false

Response

Paginated list of paywalls

data
object[]
required
meta
object
required