List groups
Lists one group type's groups, most recently seen first; key finds one group by the key events name it with.
Guide: Groups
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 <= 100The group type whose groups to list, by its key, such as organization.
Only the group with this key; the page then holds at most one.
1 <= length <= 256Only groups whose key or name property contains this, ignoring case.
length <= 255Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/analytics/groups?groupType=organization&key=org_4815" \ -H "Authorization: Bearer vh_sk_..."{ "data": [ { "id": "an_group_x7c1q8w4e6r0t5y2u8k3v9m2", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "groupType": "organization", "groupKey": "org_4815", "properties": { "name": "Lovelace Labs", "plan": "team", "seats": 12 }, "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." }}{ "error": { "type": "unavailable", "code": "string", "message": "string", "param": "string" }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | invalid_cursor | For a cursor from another list. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Groups
- Retrieve a group
GET - Update a group
PATCH - Delete a group
DELETE - List a group's people
GET
Something wrong or missing on this page? Tell us by email or on Discord.