API reference

Contacts

A contact is a person: a client or someone at a client's company, with their phone numbers and emails.

The contact object

json
{
  "id": "contact_01j8z7c1a3b5c7d9e1f3g5h7j9",
  "name": "Dilnoza Karimova",
  "phones": ["+998901234567"],
  "emails": ["[email protected]"],
  "company_id": "company_01j8z7b9c1d3e5f7g9h1j3k5m7",
  "company": { "id": "company_01j8z7b9c1d3e5f7g9h1j3k5m7", "name": "Karimov Savdo" },
  "preferred_language": "uz-Latn",
  "owner_id": null,
  "owner": null,
  "custom": {},
  "tags": ["VIP"],
  "open_leads": 2,
  "created_at": "2026-09-25T14:03:11.52Z",
  "updated_at": "2026-09-25T14:03:11.52Z"
}
FieldTypeDescription
idstringcontact_…
namestringUp to 255 characters. A contact created without a name is named after its first phone or email.
phonesarray of stringsUp to 10, normalized to international format: 90 123 45 67 and 8 90 123-45-67 become +998901234567
emailsarray of stringsUp to 10, lowercased
company_id, companystring, object or nullThe contact's company
preferred_languagestringuz-Latn, uz-Cyrl, ru, en or empty: the language to write to them in
owner_id, ownerstring, object or nullThe responsible member
customobjectCustom field values by key
tagsarray of stringsUp to 10 tag names from the workspace catalog
open_leadsintegerHow many open leads have this contact
created_at, updated_attime

List contacts

GET/v1/contactscontacts:read

Newest first. Parameters: company (a company id), q (search in the name, phones and emails), limit, cursor.

Request
curl "https://api.kweko.uz/v1/contacts?q=%2B998901234567" \
  -H "Authorization: Bearer $KWEKO_API_KEY"

Create a contact

POST/v1/contactscontacts:write
FieldDescription
nameOptional if there is a phone or email
phone / phonesOne number, or a list. Both can be sent; phone goes first.
email / emailsThe same for emails
company_idAn existing company (needs companies:read)
preferred_languageuz-Latn, uz-Cyrl, ru or en
owner_idA member id
customCustom field values by key
tagsTag names; new names join the tag catalog

At least a name, a phone or an email is required. Answers 201 with the contact and sends contact.created.

Request
curl https://api.kweko.uz/v1/contacts \
  -H "Authorization: Bearer $KWEKO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Dilnoza Karimova", "phone": "+998 90 123 45 67", "preferred_language": "uz-Latn"}'

Read, update, delete

GET/v1/contacts/{id}contacts:read
PATCH/v1/contacts/{id}contacts:write

Send only the fields to change, with the same names as on create. phones, emails and tags replace the whole list. Send null to clear company_id or owner_id. Each changed field sends a contact.updated event.

DELETE/v1/contacts/{id}contacts:write

Moves the contact to the trash.

POST/v1/contacts/{id}/restorecontacts:write

Timeline

A contact's messages, notes, calls and changes: GET /v1/timeline?entity_type=contact&entity_id=contact_…, see Notes and timeline.