List audience cohorts
Lists the cohorts a schedule's audience can name, by name.
Guide: Automations
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.
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.
Range
1 <= value <= 100Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/automations/cohorts" \ -H "Authorization: Bearer vh_sk_..."{ "data": [ { "id": "an_cohort_f2g6h0j4k8l1z5x9c3v7b1n5", "name": "Lapsed subscribers" } ], "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." }}Response body
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 this list did not return. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Automations
- List automations
GET - Create an automation
POST - Retrieve the automation catalog
GET - Retrieve an automation
GET - Update an automation
PATCH - Check an automation
POST - Test an automation
POST - Activate an automation
POST - Pause an automation
POST - Archive an automation
POST - Unarchive an automation
POST - List an automation's versions
GET - Retrieve an automation's stats
GET - List an automation's runs
GET - Start a run
POST - Retrieve a run
GET - Cancel a run
POST - Retry a run
POST
Something wrong or missing on this page? Tell us by email or on Discord.