Contacts
/api/contactsEvery contact in the organization.
contacts:readReturns. An array of contacts. Restricted lead visibility narrows this to the caller's assigned leads.
/api/contacts/paginatedOne page of contacts, with search and filters applied.
contacts:readQuery parameters
| page | number | 1-based page number. Defaults to 1. |
| limit | number | Records per page. Defaults to 10. |
| searchQuery | string | Matches name, company, email or phone. |
| filters | json | A JSON array of filter rows. Supported fields: status, source, stage, assignment, assignedTo, month, deals. |
Returns. { contacts, totalPages, currentPage }
/api/contacts/recents/{limit}The most recently created contacts.
contacts:readReturns. An array of contacts, newest first.
/api/contacts/{contactId}A single contact.
contacts:readReturns. { contact }
/api/contacts/{contactId}Update a contact.
contacts:writeBody
| any contact field | varies | Send only the fields you are changing. |
Returns. The updated contact. The change is recorded on the contact's activity timeline.
/api/contacts/{contactId}Delete a contact.
contacts:delete/api/contacts/bulk-deleteDelete several contacts at once.
contacts:deleteBody
| (body)* | string[] | An array of contact ids. |
Returns. { deletedCount }
/api/contactsBulk import contacts.
contacts:writeBody
| (body)* | Contact[] | An array of contacts, each validated the same way the form is, including your organization's required custom fields. |
Returns. { success, failed, errors, failures, imported } so partially successful imports report exactly which rows were rejected and why. `failures` gives a { row, reason } entry per rejected row, numbered against the array you sent.
/api/contacts/{contactId}/activityThe activity timeline for a contact.
contacts:readReturns. Entries describing what changed, who changed it and when — covering created, updated, deleted, assigned, unassigned and enquiry_added, for both the contact and its deals.
/api/contacts/{contactId}/assignAssign a contact to a team member.
team:writeBody
| assignedTo* | string | The id of the member to assign the contact to. |
Returns. The updated contact. The assignee is notified.
/api/contacts/{contactId}/assignRemove the current assignment.
team:write/api/contacts/refresh-stateA lightweight signal the interface uses to tell whether the contact list has changed.
contacts:read