API reference

API reference

Conversations

GET    /api/v1/conversations          List conversations
POST   /api/v1/conversations          Create a conversation
GET    /api/v1/conversations/:id      Get a conversation
PATCH  /api/v1/conversations/:id      Update a conversation
DELETE /api/v1/conversations/:id      Delete a conversation

Messages

GET    /api/v1/conversations/:id/messages    List messages
POST   /api/v1/conversations/:id/messages    Send a message

Contacts

GET    /api/v1/contacts               List contacts
POST   /api/v1/contacts               Create a contact
GET    /api/v1/contacts/:id           Get a contact
PATCH  /api/v1/contacts/:id           Update a contact
DELETE /api/v1/contacts/:id           Delete a contact

Team

GET    /api/v1/team/members           List team members
GET    /api/v1/team/invites           List pending invites
POST   /api/v1/team/invite            Send an invite

Knowledge Base

GET    /api/v1/kb/articles            List published articles
GET    /api/v1/kb/articles/:id        Get an article

Search

GET    /api/v1/search?q=:query        Search conversations, contacts, and KB

All list endpoints support ?limit (default 20, max 100) and ?cursor for pagination.