Authentication
All API requests and the MCP server require a Bearer token. API keys are scoped to a specific business with configurable permissions.Create an API Key
Using the API Key
Available Scopes
| Scope | Access |
|---|---|
contacts:read | List and search contacts |
contacts:write | Create, update, delete contacts |
conversations:read | List conversations, read messages, call logs |
conversations:write | Update conversation metadata |
messages:read | Read message history |
messages:write | Send messages |
agents:read | List and view agent configurations |
agents:write | Create, update, delete agents |
appointments:read | List and view appointments |
appointments:write | Create, update, delete appointments |
conversions:read | View conversion entries and configs |
conversions:write | Create conversion entries |
tracking:read | View tracking sessions |
tags:read / tags:write | Manage tags |
custom_fields:read / custom_fields:write | Manage custom fields |
attribution:read | Full attribution table, UTMs, presets, LTV |
stripe:read | Stripe payments, subscriptions, customers, metrics |
shopify:read | Shopify orders, customers, products, analytics |
whop:read | Whop payments, customers, memberships |