VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
List automations
Create an automation
Retrieve the automation catalog
List audience cohorts
Retrieve an automation
Update an automation
Check an automation
Test an automation
Activate an automation
Pause an automation
Archive an automation
Unarchive an automation
List an automation's versions
Retrieve an automation's stats
List an automation's runs
Start a run
Retrieve a run
Cancel a run
Retry a run

List an automation's runs

Lists the automation's runs, newest first, optionally only one person's or those in one status.

Guide: Automations

GET
/api/v1/projects/{projectId}/automations/{automationId}/runs

Authorization

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.

automationId*string

The automation's id, auto_....

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
personId?string

Only the runs of the person with this id.

status?string

Only runs in this state. queued and waiting both match every run that has not moved on yet.

Value in

  • "queued"
  • "running"
  • "waiting"
  • "paused"
  • "completed"
  • "failed"
  • "cancelled"
  • "exited"

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/automations/auto_p4n8c2v6x0z3q7w1e5r9t2y6/runs?personId=person_h7d2k9m4x1c6v8b3n5q0w2e7" \  -H "Authorization: Bearer vh_sk_..."
{  "data": [    {      "id": "auto_run_b7m3x9c5v1q8w2e6r4t0y3u9",      "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",      "automationId": "auto_p4n8c2v6x0z3q7w1e5r9t2y6",      "versionId": "auto_ver_s2d6f0g4h8j1k5l9z3x7c1v5",      "personId": "person_h7d2k9m4x1c6v8b3n5q0w2e7",      "status": "waiting",      "currentStepId": "wait",      "waitingForEvent": null,      "nextAt": "2026-03-15T09:30:00.000Z",      "lastError": null,      "event": null,      "variables": {},      "createdAt": "2026-03-14T09:30:00.000Z",      "finishedAt": null    }  ],  "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

StatustypecodeWhen
400invalid_requestinvalid_cursorFor 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
  • List audience cohorts 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
  • 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.

PreviousRetrieve an automation's statsNextStart a run

On this page

AuthorizationPath parametersQuery parametersExamplesResponse bodyErrorsMore in Automations