Retrieve a cohort
Reads one cohort, with how many people it holds now.
Guide: Cohorts
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.
cohortId*string
The cohort's id, an_cohort_....
Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/analytics/cohorts/an_cohort_q8w4e6r0t5y2u8k3v9m2x7c1" \ -H "Authorization: Bearer vh_sk_..."{ "id": "an_cohort_q8w4e6r0t5y2u8k3v9m2x7c1", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "name": "Power users", "description": "Finished three workouts in the last 30 days.", "kind": "dynamic", "definition": { "match": "all", "conditions": [ { "kind": "performed", "event": "workout_completed", "isNegated": false, "count": { "op": "gte", "value": 3 }, "withinDays": 30, "filters": [] } ] }, "memberCount": 128, "createdAt": "2026-03-05T12:00:00.000Z", "updatedAt": "2026-03-05T12:00:00.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_cohort_not_found", "message": "This project has no cohort an_cohort_q8w4e6r0t5y2u8k3v9m2x7c1.", "param": "cohortId" }}{ "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_cohort_not_found | When the project has no such cohort. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Cohorts
- List cohorts
GET - Create a cohort
POST - Preview a cohort definition
POST - Update a cohort
PATCH - Delete a cohort
DELETE - List a cohort's people
GET - Add people to a cohort
PUT - Remove a person from a cohort
DELETE
Something wrong or missing on this page? Tell us by email or on Discord.