Overview
A clean, fully documented REST API that exposes the same primitives your team uses in the Voxys UI — conversations, messages, contacts, companies, deals, and bot flows. Built for engineering teams who want to sync Voxys with their data warehouse, trigger messages from internal systems, or build custom dashboards on top of inbox and CRM data. Token-based auth, predictable JSON responses, and stable resource URLs — no GraphQL detours, no surprise breaking changes.
- Create, read, update, and delete contacts, companies, and deals
- Send outbound messages on any connected channel from your backend
- Fetch full conversation history with pagination and cursor support
- Trigger and inspect Captain AI replies via dedicated endpoints
- Manage agents, teams, inboxes, and labels programmatically
- Scoped API tokens with per-key rate limits and audit logs
- OpenAPI 3 spec, Postman collection, and code samples in 6 languages
How it works
Generate a scoped token
Create an API key in workspace settings and restrict it to the resources and scopes your integration actually needs.
Call the endpoint you need
Hit any documented REST endpoint with a Bearer token. Responses are JSON, errors are typed, and rate limits return on every header.
Combine with webhooks
Pair the API with our outbound webhooks for two-way sync — pull on demand, push on events, keep both systems consistent.