latestOpenAPI 3.1.02026-08-1014497184.0 KB

8b99dca11019

List workflow runs

Retrieves all runs for a specific workflow

get/workflows/{workflow_key}/runs

Path parameters

workflow_keystring required

Response

OK

Example response

{
  "data": [
    {
      "created_at": "2024-01-01T00:00:00Z",
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "status": {
        "next_step": 1,
        "started_at": "2024-01-01T00:00:00Z",
        "state": 2
      },
      "workflow_key": "integration.stripe.charge.succeeded"
    }
  ],
  "links": {
    "first": "https://api.magicbell.com/v1/example",
    "next": "https://api.magicbell.com/v1/example?page_next=abc",
    "prev": null
  }
}