List paywall locations

Lists the project's paywall locations, newest first, with what each shows now, and what it shows apps using a test key when that differs: 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

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

Something wrong or missing on this page? Tell us by email or on Discord.

Query parameters

cursor?string

Where the page starts: the pageInfo.endCursor of the previous page. Omit it for the first page.

limit?integer

How many items to return, from 1 to 100. Defaults to 50.

Range1 <= value <= 100

isArchived?string

true for only archived locations, false for only the others; omitted, both are listed.

Value in

"true"
"false"

slug?string

Only the location with this slug; the page then holds at most one.

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywall-locations" \  -H "Authorization: Bearer vh_sk_..."

{  "data": [    {      "id": "pw_loc_m4x1c6v8b3n5q0w2e7h7d2k9",      "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",      "name": "Onboarding upsell",      "slug": "onboarding-end",      "description": "After the last onboarding screen.",      "isArchived": false,      "archivedAt": null,      "showing": {        "id": "pw_loc_show_q2w8e4r6t1y9u3i7o5p0a2s4",        "paywallLocationId": "pw_loc_m4x1c6v8b3n5q0w2e7h7d2k9",        "type": "feature_flag",        "environment": "production",        "paywallId": null,        "buildNumber": null,        "featureFlagId": "ff_k9m4x1c6v8b3n5q0w2e7h7d2",        "startedAt": "2026-03-02T09:00:00.000Z",        "endedAt": null,        "createdByUserId": "user_k3m8q1z6v9c2x5b7n4w0e8r1"      },      "testShowing": null,      "createdAt": "2026-02-20T16:42:10.000Z",      "updatedAt": "2026-03-02T09:00:00.000Z"    },    {      "id": "pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5",      "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",      "name": "Settings upgrade",      "slug": "settings-upgrade",      "description": null,      "isArchived": false,      "archivedAt": null,      "showing": {        "id": "pw_loc_show_w4e8r2t6y0u3i7o1p5a9s3d7",        "paywallLocationId": "pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5",        "type": "paywall",        "environment": "production",        "paywallId": "pw_h7d2k9m4x1c6v8b3n5q0w2e7",        "buildNumber": 3,        "featureFlagId": null,        "startedAt": "2026-03-10T11:05:02.000Z",        "endedAt": null,        "createdByUserId": "user_k3m8q1z6v9c2x5b7n4w0e8r1"      },      "testShowing": null,      "createdAt": "2026-02-20T16:45:31.000Z",      "updatedAt": "2026-03-10T11:05:02.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."  }}

List paywall locations

Errors

More in Paywall locations

List paywall locations

Errors

More in Paywall locations

Authorization

Path parameters

Query parameters

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

List paywall locations

List paywall locations

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`