API reference

Companies

A company is an organization your contacts work for, identified in Uzbekistan by its STIR (tax number).

The company object

json
{
  "id": "co_01j8z7b9c1d3e5f7g9h1j3k5m7",
  "number": 64,
  "name": "Karimov Savdo",
  "stir": "301234567",
  "address": "Toshkent, Chilonzor 9",
  "phones": ["+998712345678"],
  "emails": ["[email protected]"],
  "owner_id": null,
  "owner": null,
  "custom": {},
  "tags": ["Partner"],
  "contacts": 3,
  "open_leads": 1,
  "created_at": "2026-09-25T14:03:11.52Z",
  "updated_at": "2026-09-25T14:03:11.52Z"
}

contacts and open_leads count the company's contacts and open leads. number is the per-workspace human number (an integer, shown as #64): assigned on create, never reused, kept on restore and by merged-away companies. See record numbers. phones, emails, owner_id, custom and tags (tags) work as on contacts.

Endpoints

GET/v1/companiescompanies:read

Newest first. Parameters: q (search), limit, cursor.

POST/v1/companiescompanies:write

Fields: name, stir, address, phones, emails, owner_id, custom, tags. A STIR must be unique in the workspace. Sends company.created.

GET/v1/companies/{id}companies:read

{id} in these routes can also be the company's plain number: GET /v1/companies/64. It is looked up only in your workspace, and an unknown number answers the same 404 as an unknown id. Numbers are a convenience for people; ids are canonical.

PATCH/v1/companies/{id}companies:write

Send only the fields to change. Each changed field sends a company.updated event.

DELETE/v1/companies/{id}companies:write
POST/v1/companies/{id}/restorecompanies:write