List a location's pins
Lists the end users pinned to a paywall at the location, newest first: each is shown their pin's paywall whatever the location shows everyone else.
Both environments unless environment names one.
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.
The location's id, pw_loc_....
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 <= 100Only the pins of one environment: production or test. Omitted, both are listed.
Value in
- "production"
- "test"
Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywall-locations/pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5/pins" \ -H "Authorization: Bearer vh_sk_..."{ "data": [ { "id": "pw_loc_pin_e7h7d2k9m4x1c6v8b3n5q0w2", "paywallLocationId": "pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5", "environment": "production", "identityType": "email", "identityValue": "ada@example.com", "paywallId": "pw_r3t6y9u2i5o8p1a4s7d0f3g6", "note": "QA device for the monthly paywall", "createdAt": "2026-03-14T09:26:53.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 Paywall locations
- List paywall locations
GET - Create a paywall location
POST - Retrieve a paywall location
GET - Update a paywall location
PATCH - Archive a paywall location
POST - Place a paywall at a location
PUT - End a location's placement
DELETE - List what a location has shown
GET - Pin an end user to a paywall
PUT - Remove a pin
DELETE - List a location's rules
GET - Replace a location's rules
PUT
Something wrong or missing on this page? Tell us by email or on Discord.