Companies

Company Engagement

Record view 2.0 (RO-335): the company's overview (state, last touch and reply, open deals, next step), its people ordered by engagement with gaps flagged (a decision maker gone quiet, no reply after several touches), and touchpoints per week for the last 12 weeks.

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/companies/{company_id}/engagement
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

company_idstring
Formatuuid

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/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/engagement" \  -H "X-Workspace-Id: string"
{
  "overview": {
    "state": "engaged",
    "last_touch_at": "2019-08-24T14:15:22Z",
    "last_reply_at": "2019-08-24T14:15:22Z",
    "touches_30d": 0,
    "replies_30d": 0,
    "open_deals": 0,
    "open_deal_value": 0.1,
    "contacts": 0,
    "gaps": 0,
    "next_step": {}
  },
  "contacts": [
    {
      "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
      "name": "string",
      "email": "string",
      "title": "string",
      "status": "string",
      "decision_maker": true,
      "touches_30d": 0,
      "replies_30d": 0,
      "meetings_30d": 0,
      "last_touch_at": "2019-08-24T14:15:22Z",
      "last_reply_at": "2019-08-24T14:15:22Z",
      "score": 0,
      "gap": "string",
      "gap_label": "string"
    }
  ],
  "touchpoints": [
    {
      "week_start": "2019-08-24",
      "outbound": 0,
      "inbound": 0,
      "calls": 0,
      "meetings": 0
    }
  ]
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}