Skip to content
On this page

Public API

Connect Elvo to other systems with a REST API. Read and write conversations, contacts, and more for integrations and automation.

Elvo has a public REST API so you can connect Elvo to other systems — read and write conversations, contacts, users, and organization data. It's built for integrations, automation, data export and AI agents.

Which one do I need?#

  • Ask Claude, ChatGPT or Copilot about your conversations, or let them draft replies: Connect Elvo to Claude, ChatGPT or Copilot. You paste one address and sign in. No token or code.
  • Let an agent that runs code (Claude Code, Codex, Cursor) or your own script work in Elvo: Build your own AI agent with the API. It uses an API token.
  • Connect another system, sync data or export conversations: this page.

This is an overview of the key points. The full reference, with every endpoint, parameter, and example, lives in the API docs.

API tokens#

Create a token under Settings → API & agents (you must be an admin). You choose:

  • A name and expiry.
  • Access — Read (GET/HEAD) or Write (also POST/PATCH/DELETE).

The token is shown only once — copy it immediately and store it somewhere safe. Elvo never displays it again.

Authentication#

Send the token in the Authorization header on every request. The base URL is https://elvo.is/api/public/v1.

curl https://elvo.is/api/public/v1/conversations \
  -H "Authorization: Bearer elvo_xxxxxxxxxxxxxxxxxxxx"

What you can do#

  • Conversations — fetch, create, and update tickets and messages — including status, assignment, drafts, snooze and tags (filter by tag with ?tag=).
  • Contacts, customers and users — read and update, and invite new users.
  • Internal chats and mentions — read and send team messages, and list where you were mentioned.
  • AI knowledge — manage knowledge sources, and list the questions the AI could not answer (/knowledge-gaps).
  • Settings — teams, channels (every connected mailbox, Meta page, WhatsApp number, widget and phone line, with the team it routes to), automation rules, canned responses, tags and custom fields.
  • Reports — the performance report.
  • Out of office — read, set and clear your own status via /me/out-of-office; teammates' active status appears as out_of_office on users.

Export conversations#

To export conversations, for example to analyze them or improve the AI knowledge base:

  1. List the conversations with GET /conversations. Filter by channel with channel (beacon_chat for the chat widget, or a channel type from GET /channels) and by date with created_after. Each page holds up to 100 conversations (limit=100). Pass pagination.next_cursor as cursor to get the next page.
  2. For each conversation, get every message with GET /conversations/{id}/comments.

If you only want to know what the AI could not answer, GET /knowledge-gaps lists those questions directly.

Webhooks#

Register webhooks to get real-time notifications when events happen (e.g. a new ticket arrives) instead of polling the API. Setup and event types are in the API docs.

Full reference#

Every endpoint, parameter, and code sample in multiple languages is in the API docs — where you can also try requests live.