REST API
Send your API key in theX-API-Key header.
Base URL
Find your base URL in Settings › API & MCP. Open REST API. The examples there already include it, ready to copy. Use it as$B2B_API_BASE in the examples on this page. All paths below are relative to it.
First calls
Permissions
There are no scopes. A key has owner-level access to its one workspace, so treat it like a password. A key works only in its own workspace. Asking for another with theX-Workspace-Id header returns 403.
Some actions always need a person signed in, and a key gets 403:
- turning on automatic approval or auto-reply that sends by itself,
- changing a live campaign’s approval steps,
- loosening safety settings,
- replying to a person directly from Inbox,
- turning on Let AI tools approve and send messages.
403, unless an owner or admin has turned on Let AI tools approve and send messages. See MCP.
Rate limits
We don’t set a general per-key request limit today. Some actions have their own:
Other actions can have limits too, and they answer the same way. Handle
429 by waiting and trying again. If the response has a Retry-After header, wait that long. Sending limits on your senders always apply, however a message is started.
Errors
The response body has a
detail field. It’s either a sentence or an object with code and message.
Before you build
Related
API quickstart
Add a person and read results in a few requests.
API keys
Make, replace or turn off your key.
Webhooks
Events, payloads and retries.
MCP
Connect an AI tool.
Integrations
Send people in from another tool.