Overview
| Endpoint | Description |
|---|---|
GET /build/companies | List companies with pagination |
GET /companies/{id} | Get a single company |
POST /build/companies | Create a new company |
PATCH /companies/{id} | Update a company |
List Companies
/api/external/v2/build/companiesList companies in your account
Response (200):
{
"request_id": "d4e5f6a7-b8c9-0123-def0-234567890123",
"timestamp": "2026-03-20T15:30:45Z",
"data": [
{
"id": 12,
"name": "Meridian Capital Group",
"website": "https://meridiancapital.com",
"address": "1 Battery Park Plaza",
"city": "New York",
"state": "NY",
"zip": "10004",
"org_id": 4521,
"linkedin_url": "https://linkedin.com/company/meridian-capital",
"is_connected": true,
"owner_account_id": 56,
"created_at": "2025-08-12T09:00:00Z",
"updated_at": "2026-02-15T14:30:00Z"
}
],
"pagination": {
"total": 34,
"limit": 50,
"has_more": false,
"next_cursor": null
}
}unauthorizedAuthentication required— Missing or invalid Authorization header
bad_requestcursor and sort cannot be combined; use offset pagination when sorting— Both cursor and sort params provided
Get Company
/api/external/v2/companies/{company_id}Get a single company by ID
Response (200):
{
"request_id": "e5f6a7b8-c9d0-1234-ef01-345678901234",
"timestamp": "2026-03-20T15:30:45Z",
"data": {
"id": 12,
"name": "Meridian Capital Group",
"website": "https://meridiancapital.com",
"address": "1 Battery Park Plaza",
"city": "New York",
"state": "NY",
"zip": "10004",
"org_id": 4521,
"linkedin_url": "https://linkedin.com/company/meridian-capital",
"is_connected": true,
"owner_account_id": 56,
"created_at": "2025-08-12T09:00:00Z",
"updated_at": "2026-02-15T14:30:00Z"
}
}unauthorizedAuthentication required— Missing or invalid Authorization header
not_foundCompany not found— The ID doesn't exist or isn't accessible to the authenticated user
Create Company
/api/external/v2/build/companiesCreate a new company
Response (201):
{
"request_id": "f6a7b8c9-d0e1-2345-f012-456789012345",
"timestamp": "2026-03-20T15:30:45Z",
"data": {
"id": 45,
"name": "Eastdil Secured",
"website": "https://eastdilsecured.com",
"address": "40 West 57th Street",
"city": "New York",
"state": "NY",
"zip": "10019",
"org_id": null,
"linkedin_url": "https://linkedin.com/company/eastdil-secured",
"is_connected": false,
"owner_account_id": 56,
"created_at": "2026-03-20T15:30:45Z",
"updated_at": "2026-03-20T15:30:45Z"
}
}unauthorizedAuthentication required— Missing or invalid Authorization header
forbiddenUser not authorized to create company— The user's role doesn't have CREATE permission
validation_errorname is required— Missing required name field
validation_errorcompany_type is required— Missing required company_type field
Update Company
/api/external/v2/companies/{company_id}Update a company
All request body fields are optional.
Response (200):
{
"request_id": "a7b8c9d0-e1f2-3456-0123-567890123456",
"timestamp": "2026-03-20T15:30:45Z",
"data": {
"id": 12,
"name": "Meridian Capital Group",
"website": "https://meridiancapital.com",
"address": "1 Battery Park Plaza, Suite 800",
"city": "New York",
"state": "NY",
"zip": "10004",
"org_id": 4521,
"linkedin_url": "https://linkedin.com/company/meridian-capital",
"is_connected": true,
"owner_account_id": 56,
"created_at": "2025-08-12T09:00:00Z",
"updated_at": "2026-03-20T15:30:45Z"
}
}unauthorizedAuthentication required— Missing or invalid Authorization header
not_foundCompany not found— The ID doesn't exist or isn't accessible to the authenticated user
Company Object
| Field | Type | Description |
|---|---|---|
id | integer | Company identifier |
name | string|null | Company name |
website | string|null | Website URL |
address | string|null | Street address |
city | string|null | City |
state | string|null | State |
zip | string|null | ZIP code |
org_id | integer|null | Linked global organization ID |
owner_account_id | integer|null | Owning account ID |
is_connected | boolean | Whether this is a connected company |
linkedin_url | string|null | LinkedIn URL |
created_at | string|null | Creation timestamp |
updated_at | string|null | Last update timestamp |