Assistant Briefing

A compact daily briefing (RO-300): activity since `since` (default the last 24 hours, at most 31 days back), what needs the user (drafts to review, replies with an open draft, handoff requests) and today's meetings, AI callbacks and calls in the workspace's time zone. An API key or connector sees the sections its scopes can read (`leads:read`, `analytics:read`, `replies:read`, `sequences:read`, `calls:read`); the others are named in `omitted`.

API key access

Any valid API key, whatever its scopes.

GET/api/v1/assistant/briefing

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

since?string

Start of the activity window (default: 24 hours ago).

Formatdate-time

limit?integer

Items per list (default 5).

Formatint64

Range1 <= value <= 20

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/assistant/briefing?since=2019-08-24T14%3A15%3A22Z&limit=1" \
  -H "X-Workspace-Id: string"

curl -X GET "http://localhost:8000/api/v1/assistant/briefing?since=2019-08-24T14%3A15%3A22Z&limit=1" \  -H "X-Workspace-Id: string"

{
  "since": "2019-08-24T14:15:22Z",
  "until": "2019-08-24T14:15:22Z",
  "timezone": "string",
  "today": "2019-08-24",
  "activity": {
    "new_leads": 0,
    "emails_sent": 0,
    "replies": {},
    "calls": {},
    "meetings_booked": 0
  },
  "needs_you": {
    "email_drafts_pending": 0,
    "reply_drafts_pending": 0,
    "reply_drafts_approved": 0,
    "replies_to_answer": [
      {
        "reply_id": "79a45e7a-a6ca-45c7-8601-f9f39611b29a",
        "lead": {},
        "category": "string",
        "summary": "string",
        "received_at": "2019-08-24T14:15:22Z",
        "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",
        "draft_status": "string"
      }
    ],
    "handoffs": [
      {
        "call_id": "0d0a16ab-a508-4d58-bf24-5dc3cb248f3e",
        "lead": {},
        "reason": "string",
        "requested_at": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "today_agenda": {
    "meetings": [
      {
        "kind": "meeting",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "starts_at": "2019-08-24T14:15:22Z",
        "ends_at": "2019-08-24T14:15:22Z",
        "title": "string",
        "lead": {},
        "call_id": "0d0a16ab-a508-4d58-bf24-5dc3cb248f3e",
        "status": "string",
        "note": "string",
        "prep_ready": true
      }
    ],
    "callbacks": [
      {
        "kind": "meeting",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "starts_at": "2019-08-24T14:15:22Z",
        "ends_at": "2019-08-24T14:15:22Z",
        "title": "string",
        "lead": {},
        "call_id": "0d0a16ab-a508-4d58-bf24-5dc3cb248f3e",
        "status": "string",
        "note": "string",
        "prep_ready": true
      }
    ],
    "calls": {}
  },
  "omitted": [
    "string"
  ]
}

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

Authorization

Query Parameters

Header Parameters

Response Body

200

422