Retrieve a group
Reads one group with its current properties.
Guide: Groups
AuthorizationBearer <token>
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
projectId*string
The project's id, proj_.... A secret key works only in the project it belongs to.
groupId*string
The group's id, an_group_....
Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/analytics/groups/an_group_x7c1q8w4e6r0t5y2u8k3v9m2" \ -H "Authorization: Bearer vh_sk_..."{ "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"}{ "error": { "type": "invalid_request", "code": "string", "message": "string", "param": "string" }}{ "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": "analytics_group_not_found", "message": "This project has no group an_group_x7c1q8w4e6r0t5y2u8k3v9m2.", "param": "groupId" }}{ "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 |
|---|---|---|---|
| 404 | not_found | analytics_group_not_found | When the project has no such group. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Groups
- List groups
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.