Companies
List Companies
Companies in the workspace, newest first (cursor pagination).
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/companiesAuthorizationBearer <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
q?string | null
Name or domain contains
Length
length <= 200industry?string | null
Length
length <= 100country?string | null
Length
length <= 2sort?CompanySortField | 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)
Length
length <= 2048limit?integer
Format
int64Range
1 <= value <= 200Header 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?q=string&industry=string&country=st&order=asc&cursor=string&limit=1" \ -H "X-Workspace-Id: string"{
"items": [
{
"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"
}
],
"next_cursor": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}