Companies
Customer and prospect companies — the core object every CRM record links to.
A company (customer in the API) is the center of the CRM. People, opportunities, visits, trials, quotes, orders, contracts, support tickets, and email threads all link to a company. The company card shows all of them on one page; in the API, GET /api/v1/customers/{id} returns the same content.
Status
| Value | Meaning |
|---|---|
Prospect |
Prospect — a company you haven't sold to yet. The default for new companies. |
AC |
Active customer. A company automatically becomes AC when an opportunity is won. |
Companies are never deleted; they're deactivated (active: false). Inactive companies drop out of lists and reminders, and their history is preserved. The API has no delete endpoint; GET /api/v1/customers?active=0 lists inactive companies. Details: Archiving and deletion.
Fields
List endpoints return each company in the row format; the single-record endpoint returns the card format. The card includes every field in the row.
| Field | Type | Description |
|---|---|---|
id |
integer | ID within the installation. |
rid |
string | 15-character permanent record ID (001…). Record IDs. |
name |
string | Company name (up to 200 characters). |
status, status_label |
string | AC / Prospect and its display name. |
owner |
user | Owning sales rep (id, full_name, role). |
city, sector, phone |
string | Contact details. |
main_contact |
object | The main contact's name, phone, email, and WhatsApp number (wa). |
visit_state |
string | Visit schedule: overdue overdue, soon coming up, ok, none no schedule. |
last_visit, next_visit_due |
date | Date of the last visit and of the next scheduled visit. |
open_opps |
integer | Number of open opportunities. |
at_risk |
boolean | The customer is at risk (no visits or orders for a long time). |
potential_kg, unit |
number, string | Monthly potential and the installation's base unit. Units and currency. |
currency |
string | The company's transaction currency. |
pending_state |
string | Status of the most urgent open action. |
The card also includes address, website, note, supplier_note (current supplier), barrier (obstacle), mgmt_support, visit_period_days, share fields (share_start, share_current, share_target), volume targets (our_kg_current, our_kg_target, commit_kg), contacts, opps, visits, demos, offers, orders, open_actions, events (timeline), competitors, prices, threads, and can_edit.
Duplicate protection
When you create a company, its name is compared against existing companies:
- If the same name exists (ignoring case, company-type suffixes, and punctuation), you get
409 exists, and the existing company is returned in thecustomerfield. - If similar names exist, you get
409 similar, and the candidates are returned in thesimilarlist. Pick the right company, or sendconfirm_new: trueto create the new one anyway.
This rule is the same for create a company, log an activity, and inbound hooks (forms, data sync).
Automatically created companies
Email sync, form submissions, and the Segment and data sync hooks can create new companies. Companies created from email are identified by their domain (auto_domain) and show an "auto-created" (otomatik açıldı) banner on the company card; if the match is wrong, the user can undo it with one click.