> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lumos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Aircall

## After this article

You will be able to connect Aircall to Lumos to sync Aircall users for visibility, Access Reviews, and offboarding, including deprovisioning Aircall users directly from Lumos.

## Capabilities

| Functionality | Type | Sync | Provision | Description |
| :- | :- | :- | :- | :- |
| Users | Account | Yes | Yes | User accounts, deprovisioning supported (see below) |

| Deprovisioning Action | Type | Description |
| :- | :- | :- |
| Delete | User | Permanently removes the user and their data from Aircall and reclaims a license |

**Status mapping:** if Aircall returns the user, Lumos shows the account as **Active**. If Aircall no longer returns the user (deleted), Lumos shows **Deprovisioned**.

> **Warning:** deprovisioning an Aircall user through Lumos permanently deletes the user in Aircall. All data associated with the user is destroyed and **is not recoverable**.

## Required plan and roles

* **Aircall plan:** no minimum Aircall plan is required to connect this integration.
* **Aircall role:** your Aircall user must be an **Admin** to authorize the connection.
* **OAuth scope:** `public_api` (default, enabled). This is the only scope requested during setup, and it lets Lumos call the Aircall APIs.
* **Permission scoping:** the connection is used to list users (read) and, when you trigger it, to delete users (write). There is no separate read-only variant.

## Read-only access vs provisioning

**Is read-only possible?** No. Aircall authorizes this connection with a single `public_api` scope that covers both listing users and deleting them, and there is no narrower scope or separate read-only variant documented.

**What full provisioning requires.** An Aircall Admin authorizing the connection and accepting the `public_api` scope during the OAuth flow below. That same scope is what enables the Delete deprovisioning action once connected.

**Watch out for.** The `public_api` scope can't be narrowed, so any working connection also has permission to delete users. The Delete action is permanent: it removes the user and all their data from Aircall and reclaims a license, and it cannot be undone.

## Instructions

**Phase 1: Connect in Lumos**

1. Find the Aircall card in your Lumos integrations (reconnect an existing card or add a new one).
2. Click **Connect Aircall**.
3. You are redirected to Aircall. Log in as an Admin and accept the requested scopes to finish connecting the integration.

## API Endpoints Used

<Note>
  The API endpoints this integration uses are available to logged-in Lumos customers. [Log in](/login) to view them.
</Note>

## Troubleshooting

**Connection fails during OAuth.** Confirm the Aircall user authorizing the connection is an Admin. Non-admin users cannot grant the `public_api` scope.

**A user disappeared from the sync.** Aircall stops returning deleted users, so Lumos marks the account **Deprovisioned**. Check the user's status in the Aircall admin console.

**Deprovisioned a user by mistake.** The deletion is permanent on the Aircall side and the user's data cannot be recovered. You will need to re-create the user in Aircall.