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

# Aircall

> How to set up the Aircall connector, plus the actions and events that are available.

![Aircall](https://stackone-logos.com/api/aircall/filled/svg)

v1.3.1[See changelog](https://docs.stackone.com/connectors/aircall/changelog.md)

[82 actions](#actions) · [8 events](#events) · 2 auth methods

Telephony
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/aircall/guides/connector-profile/api-key.md)
>
> Admin privileges are required in your Aircall dashboard to generate an API key.

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/aircall/guides/connector-profile/oauth-2-0.md)
>
> Requires an Aircall technology partner app, whose client credentials Aircall issues on request. The connection covers th...

Optionally, configure receiving Events for Aircall into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/aircall/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/aircall/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/aircall/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

public\_api

No scopes found

82 actions

ActionDescriptionRequired scopes

List Calls`aircall_list_all_calls`

Retrieve a paginated list of calls in the company.

`public_api`

Get Call`aircall_retrieve_a_call`

Retrieve a single call by ID.

`public_api`

Search Calls`aircall_search_calls`

Search calls by phone number, user, tags, or other filters.

`public_api`

Comment Call`aircall_comment_a_call`

Add a comment to a call.

`public_api`

Tag Call`aircall_tag_a_call`

Apply one or more tags to a call.

`public_api`

Archive Call`aircall_archive_a_call`

Archive a call.

`public_api`

Unarchive Call`aircall_unarchive_a_call`

Unarchive a previously archived call.

`public_api`

Delete Call Recording`aircall_delete_call_recording`

Delete the recording of a call.

`public_api`

Delete Call Voicemail`aircall_delete_call_voicemail`

Delete the voicemail recording of a call.

`public_api`

Create Call Insight Card`aircall_insight_cards`

Attach an Insight Card to a call.

`public_api`

Get Call Transcription`aircall_retrieve_a_transcription`

Retrieve the transcription of a call.

`public_api`

Get Call Realtime Transcription`aircall_retrieve_realtime_transcription`

Retrieve the realtime transcription of an ongoing call.

`public_api`

Get Call Sentiments`aircall_retrieve_sentiments`

Retrieve sentiment analysis for a call.

`public_api`

Get Call Topics`aircall_retrieve_topics`

Retrieve detected topics for a call.

`public_api`

Get Call Summary`aircall_retrieve_a_summary`

Retrieve the AI-generated summary for a call.

`public_api`

Get Call Custom Summary Result`aircall_retrieve_a_custom_summary_result`

Retrieve a custom summary result for a call.

`public_api`

Get Call Action Items`aircall_retrieve_action_items`

Retrieve AI-extracted action items for a call.

`public_api`

Get Call Playbook Result`aircall_retrieve_a_playbook_result`

Retrieve playbook evaluation result for a call.

`public_api`

Get Call Evaluations`aircall_retrieve_call_evaluations`

Retrieve evaluations submitted for a call.

`public_api`

Get Company`aircall_retrieve_company_information`

Retrieve information about the Aircall company associated with the authenticated account.

`public_api`

List Contacts`aircall_list_all_contacts`

Retrieve a paginated list of contacts in the Aircall address book.

`public_api`

Search Contacts`aircall_search_contacts`

Search contacts by phone number or email.

`public_api`

Get Contact`aircall_retrieve_a_contact`

Retrieve a single contact by ID.

`public_api`

Create Contact`aircall_create_a_contact`

Create a new contact in the address book.

`public_api`

Update Contact`aircall_update_a_contact`

Update an existing contact.

`public_api`

Delete Contact`aircall_delete_a_contact`

Delete a contact from the address book.

`public_api`

Add Phone Number To Contact`aircall_add_phone_number_to_a_contact`

Add a new phone number to an existing contact.

`public_api`

Update Contact Phone Number`aircall_update_a_phone_number_from_a_contact`

Update a phone number entry on a contact.

`public_api`

Delete Contact Phone Number`aircall_delete_a_phone_number_from_a_contact`

Delete a phone number entry from a contact.

`public_api`

Add Email To Contact`aircall_add_email_to_a_contact`

Add a new email address to a contact.

`public_api`

Update Contact Email`aircall_update_an_email_from_a_contact`

Update an email entry on a contact.

`public_api`

Delete Contact Email`aircall_delete_an_email_from_a_contact`

Delete an email entry from a contact.

`public_api`

Get Dialer Campaign`aircall_retrieve_a_dialer_campaign`

Retrieve the active dialer campaign for a user.

`public_api`

Create Dialer Campaign`aircall_create_a_dialer_campaign`

Create an active dialer campaign for a user.

`public_api`

Delete Dialer Campaign`aircall_delete_a_dialer_campaign`

Delete the active dialer campaign for a user.

`public_api`

List Dialer Campaign Phone Numbers`aircall_retrieve_phone_numbers`

Retrieve phone numbers attached to a user's dialer campaign.

`public_api`

Add Dialer Campaign Phone Numbers`aircall_add_phone_numbers`

Add phone numbers to a user's dialer campaign.

`public_api`

Delete Dialer Campaign Phone Number`aircall_delete_a_phone_number`

Remove a phone number from a user's dialer campaign.

`public_api`

Get Unified Credentials`aircall_unified_get_me`

Return metadata about the connected Aircall API key — auth\_type pinned to api\_key (single-auth connector). Aircall expos...

`public_api`

IAM Auth Test`aircall_auth_test`

Validate the current Aircall API key and return the raw, unmapped /v1/company response (company name plus user and numbe...

`public_api`

List Unified Groups`aircall_unified_list_groups`

List every Aircall Team on the connected company, mapped to the IAM unified group schema as team-style groups (type=team...

`public_api`

Get Unified Group`aircall_unified_get_group`

Retrieve a single Aircall Team by numeric ID, mapped to the IAM unified group schema as a team-style group. Pass expand=...

`public_api`

List Unified Organizations`aircall_unified_list_organizations`

Return the connected Aircall company as a single IAM organization. Aircall is single-tenant from the API key's perspecti...

`public_api`

Get Unified Organization`aircall_unified_get_organization`

Retrieve the connected Aircall company as a single IAM organization. Aircall is single-tenant from the API key's perspec...

`public_api`

List Unified Resource Types`aircall_unified_list_resource_types`

Enumerate the resource\_type values accepted by unified\_list\_resource\_users on this connector. Returns a flat string arra...

`public_api`

List Unified Resource Users`aircall_unified_list_resource_users`

List the users assigned to a specific Aircall Number (resource\_type=number) or the members of a specific Team (resource\_...

`public_api`

List Unified Roles`aircall_unified_list_roles`

Return the four stable workspace-scoped Aircall roles (owner / admin / supervisor / agent), synthesized from Aircall's d...

`public_api`

Get Unified Role`aircall_unified_get_role`

Retrieve a single synthesized Aircall IAM role by stable key (owner, admin, supervisor, or agent). Recognizes the StackO...

`public_api`

List Unified Users`aircall_unified_list_users`

List every user on the connected Aircall account from the V2 users endpoint, mapped to the StackOne IAM unified user sch...

`public_api`

Get Unified User`aircall_unified_get_user`

Retrieve a single Aircall user by ID via the V2 users endpoint, mapped to the IAM unified user schema.

`public_api`

List Numbers`aircall_list_all_numbers`

Retrieve a paginated list of numbers provisioned on the Aircall account.

`public_api`

Get Number`aircall_retrieve_a_number`

Retrieve a single Aircall number by ID.

`public_api`

Update Number`aircall_update_a_number`

Update an Aircall number's settings.

`public_api`

Update Music And Messages`aircall_update_music_and_messages`

Update a number's music and messages URLs.

`public_api`

Registration Status`aircall_registration_status`

Fetch compliance status for A2P 10DLC and toll-free messaging registration for a specific number.

`public_api`

Ping`aircall_ping`

Verify API connectivity and authentication with the Aircall Public API.

`public_api`

List Tags`aircall_list_all_tags`

Retrieve a paginated list of tags in the company.

`public_api`

Get Tag`aircall_retrieve_a_tag`

Retrieve a single tag by ID.

`public_api`

Create Tag`aircall_create_a_tag`

Create a new tag in the company.

`public_api`

Update Tag`aircall_update_a_tag`

Update an existing tag.

`public_api`

Delete Tag`aircall_delete_a_tag`

Delete a tag from the company.

`public_api`

List Teams`aircall_list_all_teams`

Retrieve a paginated list of teams in the company.

`public_api`

Get Team`aircall_retrieve_a_team`

Retrieve a single team by ID.

`public_api`

Create Team`aircall_create_a_team`

Create a new team in the company.

`public_api`

Delete Team`aircall_delete_a_team`

Delete a team from the company.

`public_api`

Add User To Team`aircall_add_a_user_to_a_team`

Add a user to an existing team.

`public_api`

Remove User From Team`aircall_remove_a_user_from_a_team`

Remove a user from a team.

`public_api`

Delete User`aircall_delete_a_user`

Delete an Aircall user.

`public_api`

List Users Availabilities`aircall_retrieve_list_of_users_availability`

Retrieve the availability status of all users.

`public_api`

Get User Availability`aircall_check_availability_of_a_user`

Check the current availability of a single user.

`public_api`

Start Outbound Call`aircall_start_an_outbound_call`

Initiate an outbound call from a user's Aircall Phone.

`public_api`

Dial Phone Number`aircall_dial_a_phone_number_in_the_phone`

Pre-fill a phone number in a user's Aircall Phone dialer. The target user must be signed in to the Aircall Phone app.

`public_api`

List Users V2`aircall_list_all_users_v2`

Retrieve a paginated list of users using the Aircall V2 users endpoint.

`public_api`

Get User V2`aircall_retrieve_a_user_v2`

Retrieve a single user using the Aircall V2 endpoint.

`public_api`

Create User V2`aircall_create_a_user_v2`

Create a new user using the Aircall V2 endpoint.

`public_api`

Update User V2`aircall_update_a_user_v2`

Update an existing user using the Aircall V2 endpoint.

`public_api`

List Numbers For User V2`aircall_list_all_numbers_for_a_user_v2`

Retrieve all numbers assigned to a specific user (V2).

`public_api`

List Webhooks`aircall_list_all_webhooks`

Retrieve a paginated list of webhooks configured on the company.

`public_api`

Get Webhook`aircall_retrieve_a_webhook`

Retrieve a single webhook by ID.

`public_api`

Create Webhook`aircall_create_a_webhook`

Register a new webhook.

`public_api`

Update Webhook`aircall_update_a_webhook`

Update an existing webhook.

`public_api`

Delete Webhook`aircall_delete_a_webhook`

Delete a webhook.

`public_api`

## Events

Tags

Select all
|
Clear

Calls

Contacts

Conversation Intelligence

Numbers

Users

Webhooks

No tags found

8 events

EventDescriptionTags

Reject Untokened Webhook`aircall_webhook_reject_untokened`

Rejects inbound Aircall webhook requests whose payload carries no token field.

Webhooks

Call Event`aircall_webhook_call_event`

Processes Aircall call webhook events across the call lifecycle.

CallsWebhooks

Conversation Intelligence Event`aircall_webhook_conversation_intelligence_event`

Processes Aircall Conversation Intelligence webhook events for AI-generated call artefacts.

Conversation IntelligenceWebhooks

Real-Time Transcription Event`aircall_webhook_realtime_transcription_event`

Processes Aircall real-time transcription webhook events emitted during an active call.

Conversation IntelligenceWebhooks

User Event`aircall_webhook_user_event`

Processes Aircall user webhook events for account changes and availability.

UsersWebhooks

User Event (v2)`aircall_webhook_user_v2_event`

Processes Aircall v2 user webhook events for account changes and availability.

UsersWebhooks

Contact Event`aircall_webhook_contact_event`

Processes Aircall contact webhook events (created, updated, deleted).

ContactsWebhooks

Number Event`aircall_webhook_number_event`

Processes Aircall number webhook events (created, deleted).

NumbersWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.