Aircall

API KeyCommunicationOrg connection

Org-level connection

Aircall is connected once at the org level by an admin. The credential is shared across all groups that have been granted access — individual team members don't need to connect their own accounts.

Getting your API key

1

In Aircall, go to Integrations & API → API Keys → Create an API Key. You'll get an API ID and API Token — enter both below.

Ready to connect?

Go directly to the integrations page in your dashboard.

Open Integrations →

Permissions (scopes)

These are the data scopes On Belay can be granted for Aircall. Your org admin controls which scopes are enabled per group.

ScopeDescriptionAccess
calls:readRead call logsRead only
calls:writeTag and comment on callsRead / Write
contacts:readRead contactsRead only
contacts:writeCreate and update contactsRead / Write
contacts:deleteDelete contactsAdmin
users:readRead users/agentsRead only
numbers:readRead phone numbersRead only
teams:readRead teamsRead only
tags:readRead call tagsRead only

Troubleshooting

"Invalid API key" or "Unauthorized" error

Double-check that you copied the full key without any leading/trailing spaces. Some platforms show a truncated preview — make sure to copy the full token. If the key was generated with restricted scopes, verify it includes the permissions listed above.

Connected but Claude can't access data

Check that your group has been granted access to this integration in On Belay → Groups → [your group] → Integrations. Also verify the specific scopes your group is permitted to use match what your query requires.

The key expires or stops working

Some API keys have expiration policies. Generate a new key in Aircall and update it in On Belay → Integrations → Aircall → Update key. Consider creating a dedicated service account or machine user for On Belay so the key isn't tied to a personal account.

Still stuck? We're happy to help.

Contact support →