Kerabie
API Reference

Customers

Look up and manage customers (visitors who have started conversations).

List customers

GET /customers

Query params: page, limit, search (email or name), from, to

Get a customer

GET /customers/:id

Get by email

GET /customers/by-email/:email

Update a customer

PATCH /customers/:id
{
  "name": "Jane Smith",
  "email": "jane@example.com",
  "attributes": {
    "plan": "pro",
    "company": "Acme Corp",
    "userId": "user_123"
  }
}

Delete a customer (GDPR)

DELETE /customers/:id

Permanently removes all PII associated with this customer. Conversation content is anonymised but preserved for analytics. This action is irreversible.

Tickets API

Overview numbers and CSV export for tickets.

Contacts API

List, add, update and import the people you talk to.

On this page

List customersGet a customerGet by emailUpdate a customerDelete a customer (GDPR)