Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Companies

Create Company

Create a company. 409 (with `existing_id`) if the domain is already used.

API key access

Needs the leads:write scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
POST/api/v1/companies

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

Header Parameters

X-Workspace-Id?string | null

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

Request Body

namestring
Length1 <= length <= 200
domain?string | null
Lengthlength <= 2048
size?CompanySize | null
industry?string | null
Lengthlength <= 100
country?string | null
Lengthlength <= 2

Response Body

curl -X POST "http://localhost:8000/api/v1/companies" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "domain": "string",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "size": {},
  "industry": "string",
  "country": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

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.

Delete Company

Soft-delete the company and detach its leads.