Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Timeline

Get Timeline

The lead's events from every channel, newest first (cursor pagination). 404 if the lead doesn't exist in this workspace.

API key access

Needs the leads:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
GET/api/v1/leads/{lead_id}/timeline

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Path Parameters

lead_idstring
Formatuuid

Query Parameters

type?array<EventType> | null

Repeat to match any of

channel?array<EventChannel> | null

Repeat to match any of

cursor?string | null
Lengthlength <= 64
limit?integer
Formatint64
Range1 <= value <= 200

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X GET "http://localhost:8000/api/v1/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08/timeline?type=email_sent&channel=email&cursor=string&limit=1" \  -H "X-Workspace-Id: string"
{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
      "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
      "type": "email_sent",
      "channel": "email",
      "actor_type": "user",
      "actor_id": "string",
      "payload": {
        "property1": null,
        "property2": null
      },
      "occurred_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Create Note

Add a note to the lead's timeline, written by the current user.

Answered

The outbound SIP leg was answered. A queued or ringing call becomes ``in_progress`` (with ``started_at``) right away instead of at the agent's first tool call, so calls nobody answered can be given up on quickly. Idempotent: ``recorded: false`` when the call is already in progress or has ended (``status`` says which; an ended call should be hung up).