API keys
On Scale, owners and managers create API keys under Settings, then Developers. A key lets your own software read calls, contacts and bookings, and add contacts, tasks and deals.
- Who can do it
- Owners and managers
- Plan
- Scale
- Checked
Create a key
- Step 1: Open Settings, then Developers.
- Step 2: Under API keys, give the key a name that says what uses it.
- Step 3: Choose what the key can do: Read, Write, or both.
- Step 4: Press Create key.
- Step 5: Press Copy key and store it somewhere safe. It is shown once. We keep only a fingerprint, so we cannot show it again.
Use it
Send the key as a bearer token on every request, in the header Authorization: Bearer followed by the key. The Developers page lists each address with an example. A key starts with 1bb_live_.
- Read: list and fetch calls, contacts, bookings, tasks and deals, and subscribe to webhooks.
- Write: add and change contacts, tasks and deals.
Revoke a key
Press Revoke beside the key, then Revoke key. Anything using it stops working at once, and webhook subscriptions it made are removed. If a key is lost, revoke it and create a new one.
Limits
- Each key can make 60 requests a minute. The account as a whole can make 300 a minute across all keys.
- Writes are limited to 30 a minute for the account.
- An account can create 20 keys a day.
- A key cannot be given more access later. Create a new key.
- Keys stop working if the account leaves Scale or its plan ends. They work again after an upgrade.
In your portal
Opens app.1bb.ai/settings/developers in your portal. You may be asked to sign in first.