List Calls

The workspace's calls (of live leads), newest first, each with its lead summary. `since` / `until` bound `created_at` (inclusive / exclusive; no offset = UTC).

API key access

Needs the calls:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.

GET/api/v1/calls

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

Query Parameters

status?array<CallStatus> | null

Repeat to match any of

outcome?array<CallOutcome> | null

Repeat to match any of

analysis_status?array<CallAnalysisStatus> | null

Repeat to match any of

lead_id?string | null

Formatuuid

since?string | null

Created at or after this time

Formatdate-time

until?string | null

Created before this time

Formatdate-time

sort?CallSortField | null

Sort by this field instead of newest first (then by id); the cursor of a sorted page only continues that sort

order?SortOrder

Direction of sort (default asc; nulls last)

Value in"asc" | "desc"

cursor?string | null

next_cursor of the previous page (at most 64 characters without sort)

Lengthlength <= 2048

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/calls?status=queued&outcome=booked&analysis_status=pending&lead_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&since=2019-08-24T14%3A15%3A22Z&until=2019-08-24T14%3A15%3A22Z&order=asc&cursor=string&limit=1" \
  -H "X-Workspace-Id: string"

curl -X GET "http://localhost:8000/api/v1/calls?status=queued&outcome=booked&analysis_status=pending&lead_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&since=2019-08-24T14%3A15%3A22Z&until=2019-08-24T14%3A15%3A22Z&order=asc&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",
      "direction": "outbound",
      "status": "queued",
      "outcome": {},
      "qualification_fields": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "answers": {
        "property1": "string",
        "property2": "string"
      },
      "summary": "string",
      "callback_requested": true,
      "callback_preferred_time": "string",
      "callback_reason": "string",
      "handoff_requested": true,
      "handoff_reason": "string",
      "opted_out_at": "2019-08-24T14:15:22Z",
      "provider": "string",
      "provider_call_id": "string",
      "from_number": "string",
      "to_number": "string",
      "recording_ref": "string",
      "started_at": "2019-08-24T14:15:22Z",
      "ended_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "analysis_status": {},
      "ai_summary": "string",
      "is_test": true,
      "lead": {}
    }
  ],
  "next_cursor": "string"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Authorization

Query Parameters

Header Parameters

Response Body

200

422