Introduction to OXVO APIs
Use OXVO APIs to automate support workflows, sync customer data, and operate workspace lifecycle tasks from your own systems.
The OpenAPI reference at /api is the source of truth for request and response contracts.
Choose the right API surface
Workspace APIs
Use Workspace APIs for day-to-day operations inside a workspace.
- Typical use-cases: contacts, conversations, messages, inbox setup, automation rules, webhooks, reports, and help center workflows.
- Typical teams: support engineering, backend product teams, and integration developers building customer-facing experiences.
- Auth: use a User access token for teammate-scoped actions, or a Bot access token for bot-driven workflows.
Provisioning APIs
Use Provisioning APIs for platform-level administration and workspace lifecycle management.
- Typical use-cases: create workspaces, manage workspace membership, provision platform-level users, and manage bot provisioning at scale.
- Typical teams: IT/admin teams and backend platform teams managing multi-workspace operations.
- Auth: use a Platform app token (
api_access_token) from Settings -> Developer -> Platform apps. - Sensitivity: treat provisioning tokens as high-privilege infrastructure secrets and restrict distribution.
Availability notes
Provisioning capabilities can vary by deployment model and plan. Self-managed deployments may expose additional admin-managed token and provisioning workflows.