List paywalls
Lists the project's paywalls, newest first: all of them, only archived ones (isArchived=true) or only the others (isArchived=false), or the one with a slug.
Guide: Paywalls in your app
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
Query parameters
Where the page starts: the pageInfo.endCursor of the previous page. Omit it for the first page.
How many items to return, from 1 to 100. Defaults to 50.
1 <= value <= 100true for only archived paywalls, false for only the others; omitted, both are listed.
Value in
- "true"
- "false"
Only the paywall with this slug; the page then holds at most one.
Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywalls" \ -H "Authorization: Bearer vh_sk_..."{ "data": [ { "id": "pw_h7d2k9m4x1c6v8b3n5q0w2e7", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "name": "Annual upsell", "slug": "annual-upsell", "kind": "paywall", "isArchived": false, "archivedAt": null, "thumbnailUrl": null, "createdAt": "2026-02-20T16:42:10.000Z", "updatedAt": "2026-03-10T11:03:27.000Z" } ], "pageInfo": { "endCursor": null, "hasNextPage": false }}{ "error": { "type": "invalid_request", "code": "invalid_query", "message": "The request query is invalid: Expected a finite number\n at [\"limit\"]" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "project_not_found", "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.", "param": "projectId" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
Errors
This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Paywalls
- Create a paywall
POST - Retrieve a paywall
GET - Update a paywall
PATCH - Delete a paywall
DELETE - Archive a paywall
POST - Unarchive a paywall
POST - List a paywall's builds
GET - Build a paywall
POST - Retrieve a paywall build
GET - Deploy a paywall build
POST
Something wrong or missing on this page? Tell us by email or on Discord.