Durable Workflows

List Workflow Runs

Changed on

Returns a paginated list of runs for the workflow named by the required workflow_id query parameter, newest first. List items are compact status rows; fetch a single run for its outputs and error detail.

get/v3/workflow-runs

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/workflow-runs
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

workflow_idstring required

Workflow whose runs to list. Required.

limitinteger

Max items per page (1-100). Defaults to 10 if omitted.

tokenstring

Opaque pagination token from a prior response's next_token.

Response

Successful response

has_moreboolean

Whether more pages are available

next_tokenstring nullable

Opaque cursor for the next page

Changes