List persons

Lists the project's persons, newest first, optionally only the one with a distinctId or those with an email.

Errors

Status	`type`	`code`	When
400	`invalid_request`	`invalid_cursor`	For a cursor this list did not return.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Persons

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

distinctId?string

Only the person with this distinct id; the page then holds at most one.

email?string

Only persons with this email address, matched without regard to case.

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/persons?email=ada%40example.com" \  -H "Authorization: Bearer vh_sk_..."

{  "data": [    {      "id": "person_h7d2k9m4x1c6v8b3n5q0w2e7",      "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",      "distinctId": "user_8231",      "email": "ada@example.com",      "name": "Ada Lovelace",      "isIdentified": true,      "createdAt": "2026-03-02T14:05:11.000Z"    }  ],  "pageInfo": {    "endCursor": null,    "hasNextPage": false  }}

{  "error": {    "type": "invalid_request",    "code": "invalid_cursor",    "message": "This cursor does not continue the list. Start again without a cursor.",    "param": "cursor"  }}

{  "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 persons

Errors

More in Persons

List persons

Errors

More in Persons

Authorization

Path parameters

Query parameters

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

List persons

List persons

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`