workflows

Per-contact run timeline

GET /v1/workflows/{id}/runs/{runId}/timeline

Auth required api.workflows.view

The ordered step history of one contact's run. A send_filtered event carries filter_tier/filter_reason explaining why the send was skipped (consent opt-out, global unsubscribe, suppression, or frequency cap).

Path parameters

id string<uuid> required

Resource UUID. An unparseable id reads as a clean 404 not_found.

runId string<uuid> required

The run id.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

200 The run's step timeline application/json

run_id string<uuid> required

events array<object> required

Each entry in events:

node_path string required

repeat_iteration integer optional

split_arm integer optional

event_type string required

enrolled, step_entered, wait_started, wait_met, wait_timed_out, send_filtered, send_held, send_skipped, send_failed, exited, completed, or failed.

exit_kind string optional

exit_name string optional

detail string optional

Human-readable free-text context.

filter_tier string optional

On a send_filtered event, the gate that dropped the send: frequency_cap, account, or topic.

filter_reason string optional

On a send_filtered event, the specific cause: frequency_cap, suppressed, unsubscribed_all, or opted_out.

occurred_at string<date-time> required

401 Missing, malformed, or unknown API key application/problem+json

403 Key lacks the required scope or plan limit violated application/problem+json

404 Resource not found application/problem+json

429 Per-org rate limit exceeded application/problem+json

500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json

curl 'https://api.sendops.dev/v1/workflows/00000000-0000-0000-0000-000000000000/runs/00000000-0000-0000-0000-000000000000/timeline' \
  -H "Authorization: Bearer $SENDOPS_API_KEY"

const res = await fetch("https://api.sendops.dev/v1/workflows/00000000-0000-0000-0000-000000000000/runs/00000000-0000-0000-0000-000000000000/timeline", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.SENDOPS_API_KEY}`
  },
});
const body = await res.json();

import os, requests

r = requests.get("https://api.sendops.dev/v1/workflows/00000000-0000-0000-0000-000000000000/runs/00000000-0000-0000-0000-000000000000/timeline", headers={"Authorization": f"Bearer {os.environ['SENDOPS_API_KEY']}"})
print(r.json())

application/json

{
  "run_id": "00000000-0000-0000-0000-000000000000",
  "events": [
    {
      "node_path": "string",
      "repeat_iteration": 0,
      "split_arm": 0,
      "event_type": "string",
      "exit_kind": "string",
      "exit_name": "string",
      "detail": "string",
      "filter_tier": "string",
      "filter_reason": "string",
      "occurred_at": "2026-05-17T20:00:00Z"
    }
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ],
  "attribute_id": "00000000-0000-0000-0000-000000000000",
  "content_hash": "string",
  "differs": [
    "string"
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ],
  "attribute_id": "00000000-0000-0000-0000-000000000000",
  "content_hash": "string",
  "differs": [
    "string"
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ],
  "attribute_id": "00000000-0000-0000-0000-000000000000",
  "content_hash": "string",
  "differs": [
    "string"
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ],
  "attribute_id": "00000000-0000-0000-0000-000000000000",
  "content_hash": "string",
  "differs": [
    "string"
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ],
  "attribute_id": "00000000-0000-0000-0000-000000000000",
  "content_hash": "string",
  "differs": [
    "string"
  ]
}