List a person's entitlements
Lists the perks the person can use now, one per perk, including the access of persons merged into them.
Each entry names the subscription or purchase that gives the access and when it ends; apps that check a perk through the SDKs see the same access. A secret key counts its own environment; a person's own credentials choose with x-environment: production (the default), test or all.
Guide: People and identity
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 person's id, person_.... The id of a person merged into another names the person they were merged into.
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 <= 100Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/persons/person_h7d2k9m4x1c6v8b3n5q0w2e7/entitlements" \ -H "Authorization: Bearer vh_sk_..."{ "data": [ { "perkId": "perk_c4v7b1n9m2x5z8q3w6e0r4t7", "perkSlug": "premium", "source": "subscription", "sourceId": "sub_p9o3i7u1y5t8r2e6w0q4a8s2", "sourcePersonId": "person_h7d2k9m4x1c6v8b3n5q0w2e7", "expiresAt": "2026-04-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": "person_not_found", "message": "This project has no person person_h7d2k9m4x1c6v8b3n5q0w2e7.", "param": "personId" }}{ "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
| Status | type | code | When |
|---|---|---|---|
| 404 | not_found | person_not_found | For an unknown or erased person. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Persons
- List persons
GET - Create a person
POST - Retrieve a person
GET - Update a person
PATCH - List a person's purchases
GET - List a person's subscriptions
GET - Erase a person
POST - Retrieve an erasure
GET
Something wrong or missing on this page? Tell us by email or on Discord.