{"openapi":"3.0.0","info":{"description":"Cloud-based phone system — manage calls, contacts, teams, numbers, messages (SMS/MMS/WhatsApp), tags, webhooks, analytics exports, conversation intelligence (transcription, sentiment, topics, summaries), AI voice agents, and dialer campaigns","version":[{"name":"v1","value":"v1"}]},"servers":[{"description":"Cloud-based phone system — manage calls, contacts, teams, numbers, messages (SMS/MMS/WhatsApp), tags, webhooks, analytics exports, conversation intelligence (transcription, sentiment, topics, summaries), AI voice agents, and dialer campaigns","url":"https://api.apirails.com/aircall"}],"paths":{"/v1/users":{"get":{"tags":["Users"],"parameters":[{"name":"from","in":"query","description":"Set a minimal creation date (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"to","in":"query","description":"Set a maximal creation date (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Reorder entries by created_at. Can be asc or desc. Default is asc.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"Current page number. Default is 1.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page. Default is 20. Minimum 1, maximum 50.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v1","api_endpoint":"https://api.aircall.io/v1/users"},"summary":"List all Users","description":"Fetch all Users associated to a Company and their information.","security":[{"bearerAuth":[]}]},"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v1","api_endpoint":"https://api.aircall.io/v1/users"},"summary":"Create a User","description":"Create a User. An invitation email is sent to the User; they must confirm their account before using Aircall. A user.created webhook event is sent.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Must be a valid and unique email. Mandatory field.","required":true},"first_name":{"type":"string","description":"Can't be blank if defined. Mandatory field.","required":true},"last_name":{"type":"string","description":"Can't be blank if defined. Mandatory field.","required":true},"availability_status":{"type":"string","description":"Availability status of the User. Can be available, custom (available according to Working Hours and Timezone) or unavailable.","enum":["available","custom","unavailable"]},"role_ids":{"type":"array","description":"Roles assigned to the User. Default is agent.","enum":["owner","supervisor","admin","agent"],"items":{"type":"string"}},"wrap_up_time":{"type":"number","description":"Optional number of seconds as wrap-up time after a call. Applies only to a user with the agent role. Default is 0 seconds."},"inviter_user_id":{"type":"number","description":"Optional id of the user who invited the user to create. The inviter must be an admin — a non-admin user ID returns a 400 error."}}},"example":{"email":["jeffrey.curtis@aircall.io"],"first_name":["Jeffrey"],"last_name":["Curtis"],"availability_status":["available","unavailable"],"role_ids":[["agent"]],"wrap_up_time":[30],"inviter_user_id":[456]}}}}}},"/v1/users/{id}":{"get":{"tags":["Users"],"parameters":[{"name":"id","in":"path","description":"Unique identifier or email address of the User.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v1","api_endpoint":"https://api.aircall.io/v1/users/{id}"},"summary":"Retrieve a User","description":"Retrieve details of a specific User by ID or email.","security":[{"bearerAuth":[]}]},"put":{"tags":["Users"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v1","api_endpoint":"https://api.aircall.io/v1/users/{id}"},"summary":"Update a User","description":"Update fields of a specific User, e.g. availability status based on a calendar or workforce management tool.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"first_name":{"type":"string","description":"Can't be blank if defined."},"last_name":{"type":"string","description":"Can't be blank if defined."},"availability_status":{"type":"string","description":"Availability status of the User. Can be available, custom (available according to Working Hours and Timezone) or unavailable.","enum":["available","custom","unavailable"]},"substatus":{"type":"string","description":"Possible values of substatus when availability_status is unavailable.","enum":["out_for_lunch","on_a_break","in_training","doing_back_office","other"]},"role_ids":{"type":"array","description":"Roles assigned to the User. Default is agent.","enum":["owner","supervisor","admin","agent"],"items":{"type":"string"}},"wrap_up_time":{"type":"number","description":"Number of seconds as wrap-up time after a call. Applies only to a user with the agent role."}}},"example":{"first_name":["Jeff Updated"],"last_name":["Curtis"],"availability_status":["available","unavailable"],"substatus":["on_a_break"],"role_ids":[["agent"]],"wrap_up_time":[55]}}}}},"delete":{"tags":["Users"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v1","api_endpoint":"https://api.aircall.io/v1/users/{id}"},"summary":"Delete a User","description":"Delete a User. All data associated to them is destroyed and cannot be recovered. A user.deleted webhook event is sent.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/availabilities":{"get":{"tags":["Users"],"parameters":[{"name":"from","in":"query","description":"Set a minimal creation date (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"to","in":"query","description":"Set a maximal creation date (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Reorder entries by created_at. Can be asc or desc. Default is asc.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v1","api_endpoint":"https://api.aircall.io/v1/users/availabilities"},"summary":"Retrieve list of Users availability","description":"List the detailed availability of all Users, displayed in the Dashboard's Activity Feed.","security":[{"bearerAuth":[]}]}},"/v1/users/{id}/availability":{"get":{"tags":["Users"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v1","api_endpoint":"https://api.aircall.io/v1/users/{id}/availability"},"summary":"Check availability of a User","description":"Retrieve the detailed availability of a specific User (available, offline, do_not_disturb, in_call or after_call_work).","security":[{"bearerAuth":[]}]}},"/v1/users/{id}/calls":{"post":{"tags":["Users"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v1","api_endpoint":"https://api.aircall.io/v1/users/{id}/calls"},"summary":"Start an outbound call","description":"Start an outbound call from a User's Aircall Workspace (click-to-call). The User must be available, not on a call and associated to the Number. Desktop Aircall Workspace only.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"number_id":{"type":"number","description":"Unique identifier of the Number to use for the call. Mandatory field. Number must be active (validated).","required":true},"to":{"type":"string","description":"The number to dial in E.164 format. Mandatory field.","required":true}}},"example":{"number_id":[123],"to":["+18001231234"]}}}}}},"/v1/users/{id}/dial":{"post":{"tags":["Users"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v1","api_endpoint":"https://api.aircall.io/v1/users/{id}/dial"},"summary":"Dial a phone number in Aircall Workspace","description":"Fill the User's Aircall Workspace with the number to dial. The User can then start the call and choose which Number to call from. Desktop Aircall Workspace only.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"to":{"type":"string","description":"The phone number to dial in E.164 format. Mandatory field.","required":true}}},"example":{"to":["+18001231234"]}}}}}},"/v2/users":{"get":{"tags":["Users"],"parameters":[{"name":"from","in":"query","description":"Set a minimal creation date (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"to","in":"query","description":"Set a maximal creation date (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Reorder entries by created_at. Can be asc or desc. Default is asc.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"Current page number. Default is 1.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page. Default is 20. Minimum 1, maximum 50.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v2","api_endpoint":"https://api.aircall.io/v2/users"},"summary":"List all Users V2","description":"Fetch all Users (V2 payload — no numbers array) associated to a Company. User V1 APIs will be deprecated on 2026-09-30.","security":[{"bearerAuth":[]}]},"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v2","api_endpoint":"https://api.aircall.io/v2/users"},"summary":"Create a User V2","description":"Create a User with the V2 payload. A user.created.v2 webhook event is sent.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Must be a valid and unique email. Mandatory field.","required":true},"first_name":{"type":"string","description":"Can't be blank if defined. Mandatory field.","required":true},"last_name":{"type":"string","description":"Can't be blank if defined. Mandatory field.","required":true},"availability_status":{"type":"string","description":"Availability status of the User. Can be available, custom (available according to Working Hours and Timezone) or unavailable.","enum":["available","custom","unavailable"]},"role_ids":{"type":"array","description":"Roles assigned to the User. Default is agent.","enum":["owner","supervisor","admin","agent"],"items":{"type":"string"}},"wrap_up_time":{"type":"number","description":"Optional number of seconds as wrap-up time after a call. Applies only to a user with the agent role. Default is 0 seconds."},"inviter_user_id":{"type":"number","description":"Optional id of the user who invited the user to create. The inviter must be an admin — a non-admin user ID returns a 400 error."}}},"example":{"email":["jeffrey.curtis@aircall.io"],"first_name":["Jeffrey"],"last_name":["Curtis"],"availability_status":["available","unavailable"],"role_ids":[["agent"]],"wrap_up_time":[30],"inviter_user_id":[456]}}}}}},"/v2/users/{id}":{"get":{"tags":["Users"],"parameters":[{"name":"id","in":"path","description":"Unique identifier or email address of the User.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v2","api_endpoint":"https://api.aircall.io/v2/users/{id}"},"summary":"Retrieve a User V2","description":"Retrieve details of a specific User (V2 payload — no numbers array) by ID or email.","security":[{"bearerAuth":[]}]},"put":{"tags":["Users"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v2","api_endpoint":"https://api.aircall.io/v2/users/{id}"},"summary":"Update a User V2","description":"Update fields of a specific User with the V2 payload.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"first_name":{"type":"string","description":"Can't be blank if defined."},"last_name":{"type":"string","description":"Can't be blank if defined."},"availability_status":{"type":"string","description":"Availability status of the User. Can be available, custom (available according to Working Hours and Timezone) or unavailable.","enum":["available","custom","unavailable"]},"substatus":{"type":"string","description":"Possible values of substatus when availability_status is unavailable.","enum":["out_for_lunch","on_a_break","in_training","doing_back_office","other"]},"role_ids":{"type":"array","description":"Roles assigned to the User. Default is agent.","enum":["owner","supervisor","admin","agent"],"items":{"type":"string"}},"wrap_up_time":{"type":"number","description":"Number of seconds as wrap-up time after a call. Applies only to a user with the agent role."}}},"example":{"first_name":["Jeff Updated"],"last_name":["Curtis"],"availability_status":["available","unavailable"],"substatus":["on_a_break"],"role_ids":[["agent"]],"wrap_up_time":[55]}}}}}},"/v2/users/{id}/numbers":{"get":{"tags":["Users"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"Reorder entries by created_at. Can be asc or desc. Default is asc.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"Current page number. Default is 1.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page. Default is 20. Minimum 1, maximum 50.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#user-v2","api_endpoint":"https://api.aircall.io/v2/users/{id}/numbers"},"summary":"List all Numbers for a User V2","description":"Fetch all Numbers associated to a specific User.","security":[{"bearerAuth":[]}]}},"/v1/teams":{"get":{"tags":["Teams"],"parameters":[{"name":"order","in":"query","description":"Reorder entries by created_at. Can be asc or desc. Default is asc.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"Current page number. Default is 1.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page. Default is 20. Minimum 1, maximum 50.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#team","api_endpoint":"https://api.aircall.io/v1/teams"},"summary":"List all Teams","description":"Fetch all Teams associated to a company and their information.","security":[{"bearerAuth":[]}]},"post":{"tags":["Teams"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#team","api_endpoint":"https://api.aircall.io/v1/teams"},"summary":"Create a Team","description":"Create a Team. Name must be unique in the company and at most 64 characters.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name of the Team. Can't be blank. Mandatory field.","required":true}}},"example":{"name":["Support USA"]}}}}}},"/v1/teams/{id}":{"get":{"tags":["Teams"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Team.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#team","api_endpoint":"https://api.aircall.io/v1/teams/{id}"},"summary":"Retrieve a Team","description":"Retrieve details of a specific Team.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Teams"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Team.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#team","api_endpoint":"https://api.aircall.io/v1/teams/{id}"},"summary":"Delete a Team","description":"Delete a Team. Teams are removed from Numbers call distribution. Users and Calls won't be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/teams/{team_id}/users/{user_id}":{"post":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"Unique identifier for the Team.","required":true,"schema":{"type":"number","example":""}},{"name":"user_id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#team","api_endpoint":"https://api.aircall.io/v1/teams/{team_id}/users/{user_id}"},"summary":"Add a User to a Team","description":"Add a User to a Team one by one.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"Unique identifier for the Team.","required":true,"schema":{"type":"number","example":""}},{"name":"user_id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#team","api_endpoint":"https://api.aircall.io/v1/teams/{team_id}/users/{user_id}"},"summary":"Remove a User from a Team","description":"Remove a User from a Team. Calls made and received by this User won't be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/calls":{"get":{"tags":["Calls"],"parameters":[{"name":"from","in":"query","description":"Set a minimal creation date (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"to","in":"query","description":"Set a maximal creation date (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Reorder entries by created_at. Can be asc or desc. Default is asc.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"fetch_contact","in":"query","description":"When set to true, adds contact details in response.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"fetch_short_urls","in":"query","description":"When set to true, adds short urls in response.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"fetch_call_timeline","in":"query","description":"When set to true, returns ivr_options_selected at the same level of the call.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"fetch_aiva_conv","in":"query","description":"When set to true, returns ai_voice_agents at the same level of the call.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"page","in":"query","description":"Current page number. Default is 1.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page. Default is 20. Minimum 1, maximum 50.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#call","api_endpoint":"https://api.aircall.io/v1/calls"},"summary":"List all Calls","description":"Fetch all Calls associated to a company. Only six months of history is available. Up to 10,000 calls via pagination — use the from param to go beyond the limit.","security":[{"bearerAuth":[]}]}},"/v1/calls/{id}":{"get":{"tags":["Calls"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}},{"name":"fetch_contact","in":"query","description":"When set to true, adds contact details in response.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"fetch_short_urls","in":"query","description":"When set to true, adds short urls in response.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"fetch_call_timeline","in":"query","description":"When set to true, returns ivr_options_selected at the same level of the call.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"fetch_aiva_conv","in":"query","description":"When set to true, returns ai_voice_agents at the same level of the call.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#call","api_endpoint":"https://api.aircall.io/v1/calls/{id}"},"summary":"Retrieve a Call","description":"Retrieve a Call's data like duration, direction, status, timestamps, comments or tags. For real-time call info use Calls webhook events.","security":[{"bearerAuth":[]}]}},"/v1/calls/search":{"get":{"tags":["Calls"],"parameters":[{"name":"from","in":"query","description":"Set a minimal creation date (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"to","in":"query","description":"Set a maximal creation date (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Reorder entries by created_at. Can be asc or desc. Default is asc.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"direction","in":"query","description":"Direction of the Calls. If specified, can be inbound or outbound.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["inbound","outbound"]}}},{"name":"user_id","in":"query","description":"Unique ID of the User who made or received Calls.","required":false,"schema":{"type":"number","example":""}},{"name":"phone_number","in":"query","description":"The calling or receiving phone number of Calls.","required":false,"schema":{"type":"string","example":""}},{"name":"tags","in":"query","description":"Array of Tag IDs. Implemented as an AND condition: Calls must match all tags.","required":false,"schema":{"type":"array","example":""}},{"name":"fetch_contact","in":"query","description":"When set to true, adds contact details in response.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"fetch_short_urls","in":"query","description":"When set to true, adds short urls in response.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"fetch_call_timeline","in":"query","description":"When set to true, returns ivr_options_selected at the same level of the call.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"fetch_aiva_conv","in":"query","description":"When set to true, returns ai_voice_agents at the same level of the call.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"page","in":"query","description":"Current page number. Default is 1.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page. Default is 20. Minimum 1, maximum 50.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#call","api_endpoint":"https://api.aircall.io/v1/calls/search"},"summary":"Search Calls","description":"Search for Calls by user_id, phone_number or tags. Tags are an AND condition. Only six months of history is available.","security":[{"bearerAuth":[]}]}},"/v1/calls/{id}/transfers":{"post":{"tags":["Calls"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#call","api_endpoint":"https://api.aircall.io/v1/calls/{id}/transfers"},"summary":"Transfer a Call","description":"Transfer a Call to another User, Team or an external phone number (cold transfers only). Only one of user_id, team_id or number is allowed per request.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"user_id":{"type":"string","description":"Unique identifier of the User the Call will be transferred to."},"team_id":{"type":"string","description":"Unique identifier of the Team the Call will be transferred to."},"number":{"type":"string","description":"External phone number the Call will be transferred to. Format must be E.164. Only works for inbound calls not yet answered."},"dispatching_strategy":{"type":"string","description":"Dispatching strategy on team transfer. Only 'random', 'simultaneous' and 'longest_idle' are accepted. Default is simultaneous.","enum":["random","simultaneous","longest_idle"]}}},"example":{"user_id":["456"],"team_id":["678"],"number":["+18001234567"],"dispatching_strategy":["simultaneous"]}}}}}},"/v1/calls/{id}/comments":{"post":{"tags":["Calls"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#call","api_endpoint":"https://api.aircall.io/v1/calls/{id}/comments"},"summary":"Comment a Call","description":"Add a Comment (Note) to a Call. Maximum of 5 comments per call. A comment posted via the Public API has no owner. Once posted it cannot be updated nor deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content":{"type":"string","description":"Content of the Comment. Emojis are removed from Comments.","required":true}}},"example":{"content":["Please call back this customer!"]}}}}}},"/v1/calls/{id}/tags":{"post":{"tags":["Calls"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#call","api_endpoint":"https://api.aircall.io/v1/calls/{id}/tags"},"summary":"Tag a Call","description":"Tag a Call with existing Tags. A call.tagged webhook event is sent.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"tags":{"type":"array","description":"Array of Tag IDs.","required":true,"items":{"type":"number"}}}},"example":{"tags":[[545]]}}}}}},"/v1/calls/{id}/archive":{"put":{"tags":["Calls"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#call","api_endpoint":"https://api.aircall.io/v1/calls/{id}/archive"},"summary":"Archive a Call","description":"Set the archived attribute of a Call to true. Legacy feature for the Aircall Phone app — no functional impact in Aircall Workspace.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/calls/{id}/unarchive":{"put":{"tags":["Calls"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#call","api_endpoint":"https://api.aircall.io/v1/calls/{id}/unarchive"},"summary":"Unarchive a Call","description":"Set the archived attribute of a Call to false. Legacy feature for the Aircall Phone app — no functional impact in Aircall Workspace.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/calls/{id}/pause_recording":{"post":{"tags":["Calls"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#call","api_endpoint":"https://api.aircall.io/v1/calls/{id}/pause_recording"},"summary":"Pause recording on a Call","description":"Automatically pause the live recording of an ongoing Call when live recording is active.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/calls/{id}/resume_recording":{"post":{"tags":["Calls"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#call","api_endpoint":"https://api.aircall.io/v1/calls/{id}/resume_recording"},"summary":"Resume recording on a Call","description":"Resume the live recording of an ongoing Call after it was paused.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/calls/{id}/recording":{"delete":{"tags":["Calls"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#call","api_endpoint":"https://api.aircall.io/v1/calls/{id}/recording"},"summary":"Delete Call recording","description":"Delete the recording of a specific Call. Cannot be undone. If the account includes AI Assist, the transcription and AI insights are also deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/calls/{id}/voicemail":{"delete":{"tags":["Calls"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#call","api_endpoint":"https://api.aircall.io/v1/calls/{id}/voicemail"},"summary":"Delete Call voicemail","description":"Delete the voicemail of a specific Call. Cannot be undone.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/calls/{id}/insight_cards":{"post":{"tags":["Calls"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#call","api_endpoint":"https://api.aircall.io/v1/calls/{id}/insight_cards"},"summary":"Insight Cards","description":"Display custom data to Agents in Aircall Workspace during ongoing Calls. Payload must be less than 10KB. Cards are not stored after the Call ends.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contents":{"type":"array","description":"Lines displayed on the Insight Card. Each line type is title, shortText or user.","required":true,"items":{"type":"object","properties":{"type":{"type":"string","description":"Type of line. Should be title, shortText or user. Mandatory field.","required":true,"enum":["title","shortText","user"]},"text":{"type":"string","description":"Text displayed in the line of the Insight Card. Mandatory for title and shortText."},"link":{"type":"string","description":"Transform the line in a link."},"label":{"type":"string","description":"Text preceding the text field (shortText) or user card (user). Mandatory for user."},"user_id":{"type":"number","description":"The id of the user to be displayed. Mandatory for user type."}}}}}},"example":{"contents":[[{"type":"title","text":"My Custom CRM","link":"https://my-custom-crm.com"},{"type":"shortText","label":"Account ID","text":"6789"}]]}}}}}},"/v1/calls/{call_id}/transcription":{"get":{"tags":["Conversation Intelligence"],"parameters":[{"name":"call_id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}},{"name":"mode","in":"query","description":"Transcription mode. Can be async or realtime.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["async","realtime"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#conversation-intelligence","api_endpoint":"https://api.aircall.io/v1/calls/{call_id}/transcription"},"summary":"Retrieve a transcription","description":"Retrieve the call transcription after the call ends. Requires the AI Assist Pro package (realtime mode requires AI Assist Pro). Subscribe to transcription.created to be notified of availability.","security":[{"bearerAuth":[]}]}},"/v1/calls/{call_id}/realtime_transcription":{"get":{"tags":["Conversation Intelligence"],"parameters":[{"name":"call_id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#conversation-intelligence","api_endpoint":"https://api.aircall.io/v1/calls/{call_id}/realtime_transcription"},"summary":"Retrieve realtime transcription","description":"Retrieve a realtime transcription of a specific call, including transcribed text per participant with timestamps. Deprecated — migrate to the transcription endpoint before 2026-03-31. Requires AI Assist Pro.","security":[{"bearerAuth":[]}]}},"/v1/calls/{call_id}/sentiments":{"get":{"tags":["Conversation Intelligence"],"parameters":[{"name":"call_id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#conversation-intelligence","api_endpoint":"https://api.aircall.io/v1/calls/{call_id}/sentiments"},"summary":"Retrieve sentiments","description":"Retrieve call sentiment analysis per participant. Requires the Aircall AI Package.","security":[{"bearerAuth":[]}]}},"/v1/calls/{call_id}/predicted_csat":{"get":{"tags":["Conversation Intelligence"],"parameters":[{"name":"call_id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#conversation-intelligence","api_endpoint":"https://api.aircall.io/v1/calls/{call_id}/predicted_csat"},"summary":"Retrieve Predicted CSAT","description":"Retrieve Predicted CSAT score and drivers for a call. Requires the Aircall AI Package.","security":[{"bearerAuth":[]}]}},"/v1/calls/{call_id}/topics":{"get":{"tags":["Conversation Intelligence"],"parameters":[{"name":"call_id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#conversation-intelligence","api_endpoint":"https://api.aircall.io/v1/calls/{call_id}/topics"},"summary":"Retrieve topics","description":"Retrieve the key topics detected on a call. Requires the Aircall AI Package.","security":[{"bearerAuth":[]}]}},"/v1/calls/{call_id}/summary":{"get":{"tags":["Conversation Intelligence"],"parameters":[{"name":"call_id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#conversation-intelligence","api_endpoint":"https://api.aircall.io/v1/calls/{call_id}/summary"},"summary":"Retrieve a summary","description":"Retrieve the AI-generated summary of a call. Requires the Aircall AI Package.","security":[{"bearerAuth":[]}]}},"/v1/calls/{call_id}/custom_summary_result":{"get":{"tags":["Conversation Intelligence"],"parameters":[{"name":"call_id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#conversation-intelligence","api_endpoint":"https://api.aircall.io/v1/calls/{call_id}/custom_summary_result"},"summary":"Retrieve a custom summary result","description":"Retrieve the custom summary result for a specific call. Requires AI Assist Pro.","security":[{"bearerAuth":[]}]}},"/v1/calls/{call_id}/action_items":{"get":{"tags":["Conversation Intelligence"],"parameters":[{"name":"call_id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#conversation-intelligence","api_endpoint":"https://api.aircall.io/v1/calls/{call_id}/action_items"},"summary":"Retrieve action items","description":"Retrieve the action items detected on a call. Requires the Aircall AI Package.","security":[{"bearerAuth":[]}]}},"/v1/calls/{call_id}/playbook_result":{"get":{"tags":["Conversation Intelligence"],"parameters":[{"name":"call_id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}},{"name":"fetch_playbook","in":"query","description":"When set to true, adds playbook details in response.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#conversation-intelligence","api_endpoint":"https://api.aircall.io/v1/calls/{call_id}/playbook_result"},"summary":"Retrieve a playbook result","description":"Retrieve the playbook result for a call, e.g. BANT qualification. Requires AI Assist Pro.","security":[{"bearerAuth":[]}]}},"/v1/calls/{call_id}/evaluations":{"get":{"tags":["Conversation Intelligence"],"parameters":[{"name":"call_id","in":"path","description":"Unique identifier for the Call.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#conversation-intelligence","api_endpoint":"https://api.aircall.io/v1/calls/{call_id}/evaluations"},"summary":"Retrieve call evaluations","description":"Retrieve the QA evaluations for a specific call. Requires AI Assist Pro or AI Assist.","security":[{"bearerAuth":[]}]}},"/v1/users/{user_id}/dialer_campaign":{"get":{"tags":["Dialer Campaign"],"parameters":[{"name":"user_id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#dialer-campaign","api_endpoint":"https://api.aircall.io/v1/users/{user_id}/dialer_campaign"},"summary":"Retrieve a Dialer Campaign","description":"Retrieve the active Power Dialer campaign for a User. A User can have only one active Dialer Campaign. 404 if the User has no active campaign.","security":[{"bearerAuth":[]}]},"post":{"tags":["Dialer Campaign"],"parameters":[{"name":"user_id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#dialer-campaign","api_endpoint":"https://api.aircall.io/v1/users/{user_id}/dialer_campaign"},"summary":"Create a Dialer Campaign","description":"Create an active Dialer Campaign for a User. A User can have only one active Dialer Campaign.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"phone_numbers":{"type":"array","description":"Array of valid phone numbers. Mandatory field. Must include at least one valid phone number.","required":true,"items":{"type":"string"}}}},"example":{"phone_numbers":[["+19161112222","+18001112222"]]}}}}},"delete":{"tags":["Dialer Campaign"],"parameters":[{"name":"user_id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#dialer-campaign","api_endpoint":"https://api.aircall.io/v1/users/{user_id}/dialer_campaign"},"summary":"Delete a Dialer Campaign","description":"Delete the active Dialer Campaign. Phone numbers associated to it are destroyed as well.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{user_id}/dialer_campaign/phone_numbers":{"get":{"tags":["Dialer Campaign"],"parameters":[{"name":"user_id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#dialer-campaign","api_endpoint":"https://api.aircall.io/v1/users/{user_id}/dialer_campaign/phone_numbers"},"summary":"Retrieve phone numbers","description":"Retrieve the list of phone numbers associated to the active Dialer Campaign.","security":[{"bearerAuth":[]}]},"post":{"tags":["Dialer Campaign"],"parameters":[{"name":"user_id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#dialer-campaign","api_endpoint":"https://api.aircall.io/v1/users/{user_id}/dialer_campaign/phone_numbers"},"summary":"Add phone numbers","description":"Add phone numbers to the active Dialer Campaign. They are automatically appended in Aircall Workspace.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"phone_numbers":{"type":"array","description":"Array of valid phone numbers. Mandatory field. Must include at least one valid phone number.","required":true,"items":{"type":"string"}}}},"example":{"phone_numbers":[["+19161112222","+18001112222"]]}}}}}},"/v1/users/{user_id}/dialer_campaign/phone_numbers/{id}":{"delete":{"tags":["Dialer Campaign"],"parameters":[{"name":"user_id","in":"path","description":"Unique identifier for the User.","required":true,"schema":{"type":"number","example":""}},{"name":"id","in":"path","description":"Unique identifier for the phone number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#dialer-campaign","api_endpoint":"https://api.aircall.io/v1/users/{user_id}/dialer_campaign/phone_numbers/{id}"},"summary":"Delete a phone number","description":"Delete one phone number from the Dialer Campaign.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/numbers":{"get":{"tags":["Numbers"],"parameters":[{"name":"from","in":"query","description":"Set a minimal creation date (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"to","in":"query","description":"Set a maximal creation date (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Reorder entries by created_at. Can be asc or desc. Default is asc.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"Current page number. Default is 1.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page. Default is 20. Minimum 1, maximum 50.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#number","api_endpoint":"https://api.aircall.io/v1/numbers"},"summary":"List all Numbers","description":"Fetch all Numbers associated to a company and their information.","security":[{"bearerAuth":[]}]}},"/v1/numbers/{id}":{"get":{"tags":["Numbers"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#number","api_endpoint":"https://api.aircall.io/v1/numbers/{id}"},"summary":"Retrieve a Number","description":"Retrieve details of a specific Number, including its linked Users.","security":[{"bearerAuth":[]}]},"put":{"tags":["Numbers"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#number","api_endpoint":"https://api.aircall.io/v1/numbers/{id}"},"summary":"Update a Number","description":"Update a specific Number: name, live recording, priority, availability or Music & Messages URLs.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name of the Number. Can't be empty or null."},"availability_status":{"type":"string","description":"Updates the first Time Rule widget in the call flow. Can be open, custom or closed.","enum":["open","custom","closed"]},"is_ivr":{"type":"boolean","description":"Deprecated. Updating this will not change any behavior.","enum":[true,false]},"live_recording_activated":{"type":"boolean","description":"Set to true to enable call recording on the Number — enables both inbound AND outbound at the same time.","enum":[true,false]},"priority":{"type":"number","description":"Priority level of the number used during routing of calls. Can be null, 0 (no priority) or 1 (top priority). Default is null.","enum":[0,1]},"messages":{"type":"object","description":"URLs to the Number's music & messages files. Each value must be a valid public URL.","properties":{"welcome":{"type":"string","description":"Updates the first Audio widget found in the number flow (not inside an IVR widget)."},"waiting":{"type":"string","description":"Updates the Music on hold setting at the number level."},"ivr":{"type":"string","description":"Updates the instructions message of the first IVR widget found in the number flow."},"voicemail":{"type":"string","description":"Updates all Voicemail widgets in the number flow with the new message."},"closed":{"type":"string","description":"Deprecated. Updating this will not change any behavior."},"callback_later":{"type":"string","description":"Deprecated. Updating this will not change any behavior."},"unanswered_call":{"type":"string","description":"Deprecated. Updating this will not change any behavior."},"after_hours":{"type":"string","description":"Updates the first Voicemail widget found in the \"At any other time\" branch, or the first Audio widget in that branch."},"ringing_tone":{"type":"string","description":"Updates all Waiting Music files (Waiting Experience widget) found in the number flow."}}}}},"example":{"name":["French Office UPDATED"],"availability_status":["custom"],"is_ivr":[true],"live_recording_activated":[true],"priority":[1],"messages":[{"welcome":"https://example.com/welcome_NEW.mp3"}]}}}}}},"/v1/numbers/{id}/registration_status":{"get":{"tags":["Numbers"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#number","api_endpoint":"https://api.aircall.io/v1/numbers/{id}/registration_status"},"summary":"Registration Status","description":"Fetch compliance status for A2P 10DLC messaging registration in the US, and toll-free messaging registration in the US & Canada, for a specific Number.","security":[{"bearerAuth":[]}]}},"/v1/numbers/{id}/templates":{"get":{"tags":["Numbers"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Number.","required":true,"schema":{"type":"number","example":""}},{"name":"status","in":"query","description":"Filter templates by approval status: APPROVED, REJECTED, PAUSED, FLAGGED or PENDING_DELETION.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["APPROVED","REJECTED","PAUSED","FLAGGED","PENDING_DELETION"]}}},{"name":"category","in":"query","description":"Filter templates by category.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["UTILITY","MARKETING","AUTHENTICATION"]}}},{"name":"token","in":"query","description":"Pagination cursor. Use the nextToken from a previous response to fetch the next page.","required":false,"schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"Maximum number of templates to return per page.","required":false,"schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"Sort direction for results.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#number","api_endpoint":"https://api.aircall.io/v1/numbers/{id}/templates"},"summary":"List WhatsApp Templates","description":"Retrieve a paginated list of WhatsApp templates associated with a WhatsApp-capable number. The number must be registered for WhatsApp.","security":[{"bearerAuth":[]}]}},"/v1/numbers/{id}/whatsapp_status":{"get":{"tags":["Numbers"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#number","api_endpoint":"https://api.aircall.io/v1/numbers/{id}/whatsapp_status"},"summary":"Get WhatsApp Line Status","description":"Retrieve the current WhatsApp registration and health status of a WhatsApp-capable number: online status, messaging limit tier, quality rating and whether it can currently send messages.","security":[{"bearerAuth":[]}]}},"/v1/numbers/{id}/messages/native/send":{"post":{"tags":["Messages"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Number (line).","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#message","api_endpoint":"https://api.aircall.io/v1/numbers/{id}/messages/native/send"},"summary":"Send Message in agent conversation","description":"Send a text message from an SMS-capable number, stored and visible in the agents' conversation inbox. Not for high-volume use — use Send Message Skipping Aircall Inbox instead. Max 1600 characters.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"to":{"type":"string","description":"Number you want to send the message to. Mandatory field.","required":true},"body":{"type":"string","description":"Text you want to send. Mandatory field. Max 1600 characters.","required":true},"agentId":{"type":"number","description":"User's id to associate with the sent message. Optional field."}}},"example":{"to":["+13001234567"],"body":["text you want to send"],"agentId":[456]}}}}}},"/v1/numbers/{id}/messages/group/native/send":{"post":{"tags":["Messages"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Number (line).","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#message","api_endpoint":"https://api.aircall.io/v1/numbers/{id}/messages/group/native/send"},"summary":"Send Group Message in agent conversation","description":"Send a group text message from an SMS-capable number, stored in the group conversation and visible to agents. Up to 10 participants per group including the sender. Not for high-volume use.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"participants":{"type":"array","description":"Array of phone numbers to include in the group conversation. Mandatory field.","required":true,"items":{"type":"string"}},"body":{"type":"string","description":"Text you want to send. Mandatory field. Max 1600 characters.","required":true},"agentId":{"type":"number","description":"User's id to associate with the sent message. Optional field."}}},"example":{"participants":[["+13001234567","+13007654321"]],"body":["text you want to send"],"agentId":[456]}}}}}},"/v1/messages/send/whatsapp/native":{"post":{"tags":["Messages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#message","api_endpoint":"https://api.aircall.io/v1/messages/send/whatsapp/native"},"summary":"Send WhatsApp Message in Agent Conversation","description":"Send a WhatsApp message (text or template) from a WhatsApp-capable number, stored and visible in the agents' conversation inbox. Text can only be sent within an open 24-hour conversation window — outside the window use templateParams. Not for high-volume use.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"lineId":{"type":"number","description":"Unique identifier for the WhatsApp-capable Number. Mandatory field.","required":true},"externalNumber":{"type":"string","description":"Recipient phone number in E.164 format. Mandatory field.","required":true},"agentId":{"type":"number","description":"The agent's user ID to associate with the sent message. Optional field."},"text":{"type":"string","description":"Text message body (max 4096 characters). Mutually exclusive with templateParams. Only within an open 24-hour conversation window — outside the window sending fails with a 422 error."},"templateParams":{"type":"object","description":"Template send parameters. Mutually exclusive with text.","properties":{"id":{"type":"string","description":"Unique identifier of the WhatsApp template to use. Mandatory when templateParams is present.","required":true},"body":{"type":"array","description":"Variable substitutions for the template body. Each item must have key (String) and value (String)."},"buttons":{"type":"array","description":"Variable substitutions for template buttons. Each item must have key and value."},"header":{"type":"object","description":"Variable substitution for the template header component (image, document, or video URL). Required only for templates with a media header."}}}}},"example":{"lineId":[123],"externalNumber":["+13001234567"],"agentId":[456],"text":["Text you want to send."],"templateParams":[{"id":"1234","body":[{"key":"{{1}}","value":"Jordan"}]}]}}}}}},"/v1/sms/templates":{"get":{"tags":["Messages"],"parameters":[{"name":"search","in":"query","description":"Free-text search across the template name and body (case/diacritic-insensitive).","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Page number to retrieve. Default is 1.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of templates to return per page. Default is 20. Maximum is 100.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#message","api_endpoint":"https://api.aircall.io/v1/sms/templates"},"summary":"List SMS Templates","description":"Retrieve a paginated list of the company's SMS templates, aggregated across all agents. Filterable with a free-text search across template name and body.","security":[{"bearerAuth":[]}]}},"/v1/numbers/{id}/messages/configuration":{"post":{"tags":["Messages"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Number (line).","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#high-volume-messages","api_endpoint":"https://api.aircall.io/v1/numbers/{id}/messages/configuration"},"summary":"Create Number Configuration","description":"Create or update the configuration allowing a number to use the \"Skipping Aircall Inbox\" send endpoints. Once configured, the number cannot send or receive messages via Aircall apps. US long codes and US/CA toll-free lines must be registered before SMS configuration.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"callbackUrl":{"type":"string","description":"Callback URL used to receive message status updates and inbound messages from the recipient."},"type":{"type":"string","description":"The channel to configure the number for. Defaults to sms.","enum":["sms","whatsapp"]}}},"example":{"callbackUrl":["https://my-server.example.com/callbacks"],"type":["sms"]}}}}},"get":{"tags":["Messages"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Number (line).","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#high-volume-messages","api_endpoint":"https://api.aircall.io/v1/numbers/{id}/messages/configuration"},"summary":"Fetch Number Configuration","description":"Fetch the settings associated to a Number for the Aircall Messaging public API.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Messages"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Number (line).","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#high-volume-messages","api_endpoint":"https://api.aircall.io/v1/numbers/{id}/messages/configuration"},"summary":"Delete Number Configuration","description":"Delete the messaging configuration associated to a Number for the Aircall Messaging public API.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/numbers/{id}/messages/send":{"post":{"tags":["Messages"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Number (line).","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#high-volume-messages","api_endpoint":"https://api.aircall.io/v1/numbers/{id}/messages/send"},"summary":"Send Message Skipping Aircall Inbox","description":"Send a text or multimedia message from a public API configured number, without storing it in the Aircall agent inbox. The number must be configured first via Create Number Configuration.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"to":{"type":"string","description":"Number you want to send the message to. Mandatory field.","required":true},"body":{"type":"string","description":"Text you want to send. Max 1600 characters."},"mediaUrl":{"type":"array","description":"Media URLs you want to send. Optional field.","items":{"type":"string"}}}},"example":{"to":["+13001234567"],"body":["text you want to send"],"mediaUrl":[["https://example.com/image.png"]]}}}}}},"/v1/numbers/{id}/messages/group/send":{"post":{"tags":["Messages"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Number (line).","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#high-volume-messages","api_endpoint":"https://api.aircall.io/v1/numbers/{id}/messages/group/send"},"summary":"Send Group Message Skipping Aircall Inbox","description":"Send a group message (text or media, one or the other per request) from a public API configured number, without storing it in the Aircall agent inbox. Up to 10 participants per group including the sender.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"participants":{"type":"array","description":"Array of phone numbers to include in the group conversation. Mandatory field.","required":true,"items":{"type":"string"}},"body":{"type":"string","description":"Text you want to send. Optional field. Cannot be combined with mediaUrl."},"mediaUrl":{"type":"array","description":"Media URLs you want to send. Optional field. Cannot be combined with body.","items":{"type":"string"}}}},"example":{"participants":[["+13001234567","+13007654321"]],"body":["text you want to send"],"mediaUrl":[["https://example.com/image.png"]]}}}}}},"/v1/messages/whatsapp/send":{"post":{"tags":["Messages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#high-volume-messages","api_endpoint":"https://api.aircall.io/v1/messages/whatsapp/send"},"summary":"Send WhatsApp Message Skipping Aircall Inbox","description":"Send a WhatsApp message (text, media, or template) from a WhatsApp-capable number directly to a recipient, without storing it in the Aircall agent inbox. Designed for high-volume use. Requires the whatsapp_messaging addon. Provide only one of text, mediaUrl or templateParams per request.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"lineId":{"type":"number","description":"Unique identifier for the WhatsApp-capable Number. Mandatory field.","required":true},"to":{"type":"string","description":"Recipient phone number in E.164 format. Mandatory field.","required":true},"text":{"type":"string","description":"Text message body (max 4096 characters). Mutually exclusive with templateParams and mediaUrl. Only within an open 24-hour conversation window — outside the window returns 200 but delivers error 63016 to your webhook."},"mediaUrl":{"type":"string","description":"Publicly accessible media URL to send. Mutually exclusive with templateParams and text."},"templateParams":{"type":"object","description":"Template send parameters. Mutually exclusive with text.","properties":{"id":{"type":"string","description":"Unique identifier of the WhatsApp template to use. Mandatory when templateParams is present.","required":true},"body":{"type":"array","description":"Variable substitutions for the template body. Each item must have key (String) and value (String)."},"buttons":{"type":"array","description":"Variable substitutions for template buttons. Each item must have key and value."},"header":{"type":"object","description":"Variable substitution for the template header component (image, document, or video URL). Required only for templates with a media header."}}}}},"example":{"lineId":[123],"to":["+13001234567"],"text":["Text you want to send."],"mediaUrl":["https://example.com/image.png"],"templateParams":[{"id":"1234","body":[{"key":"{{1}}","value":"Jordan"}]}]}}}}}},"/v1/contacts":{"get":{"tags":["Contacts"],"parameters":[{"name":"from","in":"query","description":"Set a minimal creation date for contacts (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"to","in":"query","description":"Set a maximal creation date for contacts (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Reorder entries by order_by, created_at otherwise. Can be asc or desc. Default is asc.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"order_by","in":"query","description":"Set the order field, created_at or updated_at. Default is created_at.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["created_at","updated_at"]}}},{"name":"page","in":"query","description":"Current page number. Default is 1.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page. Default is 20. Minimum 1, maximum 50.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#contact","api_endpoint":"https://api.aircall.io/v1/contacts"},"summary":"List all Contacts","description":"Fetch all shared Contacts associated to a company with their phone numbers and emails. Up to 10,000 Contacts via pagination — use the from param to go beyond.","security":[{"bearerAuth":[]}]},"post":{"tags":["Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#contact","api_endpoint":"https://api.aircall.io/v1/contacts"},"summary":"Create a Contact","description":"Create a Contact. Contacts created via the Public API are automatically shared across the company. phone_numbers is required. Limit of 20 emails and 20 phone numbers. Duplicate calls with the same payload create duplicate contacts.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"first_name":{"type":"string","description":"Can't be blank if defined. Can't exceed 255 characters."},"last_name":{"type":"string","description":"Can't be blank if defined. Can't exceed 255 characters."},"company_name":{"type":"string","description":"Can't be blank if defined. Can't exceed 255 characters."},"information":{"type":"string","description":"Can't be blank if defined."},"emails":{"type":"array","description":"Array of email address objects. For each email, label and value must be set. Limit of 20.","items":{"type":"object","properties":{"label":{"type":"string","description":"A custom label like work or home."},"value":{"type":"string","description":"The email address. Mandatory field.","required":true}}}},"phone_numbers":{"type":"array","description":"Array of phone number objects. Mandatory field. For each phone_number, label and value must be set. Limit of 20.","required":true,"items":{"type":"object","properties":{"label":{"type":"string","description":"A custom label like work or home."},"value":{"type":"string","description":"The phone number. Mandatory field. The number needs to be valid.","required":true}}}}}},"example":{"first_name":["Gary"],"last_name":["Jennings"],"company_name":["Acme Inc."],"information":["external_custom_id:87123"],"emails":[[{"label":"Office","value":"gary.jennings@acme.com"}]],"phone_numbers":[[{"label":"Work","value":"+19001112222"}]]}}}}}},"/v1/contacts/search":{"get":{"tags":["Contacts"],"parameters":[{"name":"from","in":"query","description":"Set a minimal creation date for contacts (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"to","in":"query","description":"Set a maximal creation date for contacts (UNIX timestamp).","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"Reorder entries by order_by, created_at otherwise. Can be asc or desc. Default is asc.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"order_by","in":"query","description":"Set the order field, created_at or updated_at. Default is created_at.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["created_at","updated_at"]}}},{"name":"page","in":"query","description":"Current page number. Default is 1.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page. Default is 20. Minimum 1, maximum 50.","required":false,"schema":{"type":"number","example":""}},{"name":"phone_number","in":"query","description":"Phone number of a contact.","required":false,"schema":{"type":"string","example":""}},{"name":"email","in":"query","description":"Email address of a contact.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#contact","api_endpoint":"https://api.aircall.io/v1/contacts/search"},"summary":"Search Contacts","description":"Search within a company's shared Contacts by phone number or email.","security":[{"bearerAuth":[]}]}},"/v1/contacts/{id}":{"get":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Contact.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#contact","api_endpoint":"https://api.aircall.io/v1/contacts/{id}"},"summary":"Retrieve a Contact","description":"Retrieve details of a specific Contact. Only shared contacts can be found.","security":[{"bearerAuth":[]}]},"post":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Contact.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#contact","api_endpoint":"https://api.aircall.io/v1/contacts/{id}"},"summary":"Update a Contact","description":"Update a shared Contact's names, company or information. Note: this endpoint uses POST, not PUT. To update phone numbers or emails use the dedicated endpoints.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"first_name":{"type":"string","description":"Can't be blank if defined."},"last_name":{"type":"string","description":"Can't be blank if defined."},"company_name":{"type":"string","description":"Can't be blank if defined."},"information":{"type":"string","description":"Can't be blank if defined."}}},"example":{"first_name":["Vicente UPDATED"],"last_name":["Abad"],"company_name":["Lerox Inc."],"information":["external_custom_id:87123"]}}}}},"delete":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Contact.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#contact","api_endpoint":"https://api.aircall.io/v1/contacts/{id}"},"summary":"Delete a Contact","description":"Delete a contact from the Company. Only shared contacts can be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/contacts/{id}/phone_details":{"post":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Contact.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#contact","api_endpoint":"https://api.aircall.io/v1/contacts/{id}/phone_details"},"summary":"Add phone number to a Contact","description":"Add a phone number to a Contact (limit of 20 per contact). The value will be normalized before being stored.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"label":{"type":"string","description":"A custom label like work or home. Can't be blank if defined."},"value":{"type":"string","description":"The phone number. Mandatory field. Aircall stores any phone number format but the number needs to be valid.","required":true}}},"example":{"label":["Work"],"value":["+19161110000"]}}}}}},"/v1/contacts/{id}/phone_details/{phone_number_id}":{"put":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Contact.","required":true,"schema":{"type":"number","example":""}},{"name":"phone_number_id","in":"path","description":"Unique identifier for the phone number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#contact","api_endpoint":"https://api.aircall.io/v1/contacts/{id}/phone_details/{phone_number_id}"},"summary":"Update a phone number from a Contact","description":"Update a phone number of a Contact. The value field must be sent each time; it is normalized before being stored.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"label":{"type":"string","description":"A custom label like work or home. Can't be blank if defined."},"value":{"type":"string","description":"The phone number. Mandatory field.","required":true}}},"example":{"label":["Home UPDATED"],"value":["+19161110011"]}}}}},"delete":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Contact.","required":true,"schema":{"type":"number","example":""}},{"name":"phone_number_id","in":"path","description":"Unique identifier for the phone number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#contact","api_endpoint":"https://api.aircall.io/v1/contacts/{id}/phone_details/{phone_number_id}"},"summary":"Delete a phone number from a Contact","description":"Remove a phone number from a Contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/contacts/{id}/email_details":{"post":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Contact.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#contact","api_endpoint":"https://api.aircall.io/v1/contacts/{id}/email_details"},"summary":"Add email to a Contact","description":"Add an email to a Contact (limit of 20 per contact).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"label":{"type":"string","description":"A custom label like work or home. Can't be blank if defined."},"value":{"type":"string","description":"The email address. Mandatory field. Aircall stores any email format.","required":true}}},"example":{"label":["Work"],"value":["v.lightner@example.com"]}}}}}},"/v1/contacts/{id}/email_details/{email_id}":{"put":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Contact.","required":true,"schema":{"type":"number","example":""}},{"name":"email_id","in":"path","description":"Unique identifier for the Email address.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#contact","api_endpoint":"https://api.aircall.io/v1/contacts/{id}/email_details/{email_id}"},"summary":"Update an email from a Contact","description":"Update an email address of a Contact. The value field must be sent each time.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"label":{"type":"string","description":"A custom label like work or home. Can't be blank if defined."},"value":{"type":"string","description":"The email address. Mandatory field.","required":true}}},"example":{"label":["Work"],"value":["v.updated@example.com"]}}}}},"delete":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Contact.","required":true,"schema":{"type":"number","example":""}},{"name":"email_id","in":"path","description":"Unique identifier for the email address.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#contact","api_endpoint":"https://api.aircall.io/v1/contacts/{id}/email_details/{email_id}"},"summary":"Delete an email from a Contact","description":"Remove an email address from a Contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/tags":{"get":{"tags":["Tags"],"parameters":[{"name":"page","in":"query","description":"Current page number. Default is 1.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page. Default is 20. Minimum 1, maximum 50.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#tag","api_endpoint":"https://api.aircall.io/v1/tags"},"summary":"List all Tags","description":"Fetch all Tags associated to a company and their information.","security":[{"bearerAuth":[]}]},"post":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#tag","api_endpoint":"https://api.aircall.io/v1/tags"},"summary":"Create a Tag","description":"Create a Tag. The name must be unique and the color must be formatted in hexadecimal.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Can't be blank. Mandatory field. The name must be unique.","required":true},"color":{"type":"string","description":"Can't be blank and must be formatted in hexadecimal. Mandatory field.","required":true}}},"example":{"name":["VIP Customer"],"color":["#00B388"]}}}}}},"/v1/tags/{id}":{"get":{"tags":["Tags"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Tag.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#tag","api_endpoint":"https://api.aircall.io/v1/tags/{id}"},"summary":"Retrieve a Tag","description":"Retrieve details of a specific Tag.","security":[{"bearerAuth":[]}]},"put":{"tags":["Tags"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Tag.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#tag","api_endpoint":"https://api.aircall.io/v1/tags/{id}"},"summary":"Update a Tag","description":"Update a Tag. The name must be unique and the color must be formatted in hexadecimal.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Can't be blank. Mandatory field. The name must be unique.","required":true},"color":{"type":"string","description":"Can't be blank and must be formatted in hexadecimal. Mandatory field.","required":true}}},"example":{"name":["Tier 2 Customer"],"color":["#00B388"]}}}}},"delete":{"tags":["Tags"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Tag.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#tag","api_endpoint":"https://api.aircall.io/v1/tags/{id}"},"summary":"Delete a Tag","description":"Delete a Tag. The Tag will be removed from Calls.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/webhooks":{"get":{"tags":["Webhooks"],"parameters":[{"name":"order","in":"query","description":"Reorder entries by created_at. Can be asc or desc. Default is asc.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"Current page number. Default is 1.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page. Default is 20. Minimum 1, maximum 50.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#webhook","api_endpoint":"https://api.aircall.io/v1/webhooks"},"summary":"List all Webhooks","description":"Fetch all Webhooks associated to a company. Max 100 webhooks per company. With OAuth only the webhook linked to the token is accessible.","security":[{"bearerAuth":[]}]},"post":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#webhook","api_endpoint":"https://api.aircall.io/v1/webhooks"},"summary":"Create a Webhook","description":"Create a Webhook with a list of attached events. Max 100 webhooks per company. If the events field is empty, all events will be attached.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"url":{"type":"string","description":"Can't be blank and must be a valid URL. Mandatory field on create."},"custom_name":{"type":"string","description":"Custom name of the Webhook. Default is 'Webhook'."},"events":{"type":"array","description":"List of events registered. If empty, all events will be attached to this webhook.","items":{"type":"string"}}}},"example":{"url":["https://my-server.example.com/webhooks/contacts"],"custom_name":["My Custom Workflow"],"events":[["contact.created","contact.updated","contact.deleted"]]}}}}}},"/v1/webhooks/{webhook_id}":{"get":{"tags":["Webhooks"],"parameters":[{"name":"webhook_id","in":"path","description":"Unique identifier (UUID) for the Webhook. The old numeric Webhook id can also be used.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#webhook","api_endpoint":"https://api.aircall.io/v1/webhooks/{webhook_id}"},"summary":"Retrieve a Webhook","description":"Retrieve details of a specific Webhook.","security":[{"bearerAuth":[]}]},"put":{"tags":["Webhooks"],"parameters":[{"name":"webhook_id","in":"path","description":"Unique identifier (UUID) for the Webhook. The old numeric Webhook id can also be used.","required":true,"schema":{"type":"string","example":""}},{"name":"events_action","in":"query","description":"Use to add or remove specific events from the existing list of events. Can be add or remove.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["add","remove"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#webhook","api_endpoint":"https://api.aircall.io/v1/webhooks/{webhook_id}"},"summary":"Update a Webhook","description":"Update a Webhook. Also used to re-activate webhooks automatically disabled by Aircall. If the events field is not specified, the webhook will be registered to all events by default — use the events_action query param to add or remove specific events instead.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"url":{"type":"string","description":"Can't be blank and must be a valid URL. Mandatory field on create."},"custom_name":{"type":"string","description":"Custom name of the Webhook. Default is 'Webhook'."},"events":{"type":"array","description":"List of events registered. If empty, all events will be attached to this webhook.","items":{"type":"string"}},"active":{"type":"boolean","description":"Set to true to re-activate a Webhook or false to disable it (update only).","enum":[true,false]}}},"example":{"url":["https://my-server.example.com/webhooks/contacts"],"custom_name":["My Custom Workflow"],"events":[["contact.created","contact.updated","contact.deleted"]],"active":[true]}}}}},"delete":{"tags":["Webhooks"],"parameters":[{"name":"webhook_id","in":"path","description":"Unique identifier (UUID) for the Webhook. The old numeric Webhook id can also be used.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#webhook","api_endpoint":"https://api.aircall.io/v1/webhooks/{webhook_id}"},"summary":"Delete a Webhook","description":"Delete a Webhook. Aircall will stop sending events and the configuration will be lost.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/company":{"get":{"tags":["Company"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#company","api_endpoint":"https://api.aircall.io/v1/company"},"summary":"Retrieve Company information","description":"Retrieve the Company information: name, number of Users and Numbers.","security":[{"bearerAuth":[]}]}},"/v1/integrations/me":{"get":{"tags":["Integration"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#integration","api_endpoint":"https://api.aircall.io/v1/integrations/me"},"summary":"Retrieve Integration information","description":"Retrieve the integration associated to the access token. Only available for integrations built by Aircall or 3rd parties using OAuth — not retrievable with Basic Auth.","security":[{"bearerAuth":[]}]}},"/v1/integrations/enable":{"post":{"tags":["Integration"],"parameters":[{"name":"install","in":"query","description":"Pass if first time enabled to see the integration in the dashboard.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#integration","api_endpoint":"https://api.aircall.io/v1/integrations/enable"},"summary":"Enable Integration","description":"Enable the integration associated to the access token and activate webhooks on it. OAuth only. Pass the install query param on first-time enable to redirect the user to the integration settings page.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/integrations/disable":{"post":{"tags":["Integration"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#integration","api_endpoint":"https://api.aircall.io/v1/integrations/disable"},"summary":"Disable Integration","description":"Disable the integration associated to the access token and de-activate webhooks on it. OAuth only.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/analytics/report/export":{"post":{"tags":["Analytics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#analytics","api_endpoint":"https://api.aircall.io/v1/analytics/report/export"},"summary":"Create an Analytics Report Export","description":"Submit an asynchronous export job for one of 12 supported analytics report types. Requires the Analytics+ entitlement. Provide exactly one of dateFilter.relative or dateFilter.absoluteRange. Poll the retrieve endpoint or subscribe to analytics.report_created / analytics.report_failed webhook events.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"input":{"type":"object","description":"Wrapper for the export request payload. Mandatory field.","required":true,"properties":{"reportName":{"type":"string","description":"Type of report to export. One of the 12 enum values: CALLS_HISTORY, USER_STATUS_HISTORY, USER_ACTIVITY_AVAILABILITY_BREAKDOWN, USER_ACTIVITY_AVERAGE_AFTER_CALL_WORK_TIME_PER_USER, USER_ACTIVITY_AVERAGE_INBOUND_IN_CALL_TIME_PER_USER, USER_ACTIVITY_AVERAGE_OUTBOUND_IN_CALL_TIME_PER_USER, USER_ACTIVITY_CALL_VOLUME_AND_TIME, USER_ACTIVITY_CALLS_HANDLED, USER_ACTIVITY_PERCENTAGE_OF_TIME_IN_EACH_STATUS, USER_ACTIVITY_RINGING_ATTEMPTS_PER_USER, USER_ACTIVITY_WORK_TIME_AND_AVAILABILITY, USER_ACTIVITY_RINGING_ATTEMPTS. Mandatory field.","required":true},"filter":{"type":"object","description":"Filters applied to the report data. Mandatory field.","required":true},"options":{"type":"object","description":"Report-specific options such as date breakdown and SLA configuration."},"exportOptions":{"type":"object","description":"File-level options such as format and file name."}}}}},"example":{"input":[{"reportName":"CALLS_HISTORY","filter":{"dateFilter":{"absoluteRange":{"fromDate":"2026-05-01","toDate":"2026-05-15"}},"timezone":"Europe/Paris"}}]}}}}}},"/v1/analytics/report/export/{export_id}":{"get":{"tags":["Analytics"],"parameters":[{"name":"export_id","in":"path","description":"The ID of the export job to retrieve. Returned by Create an Analytics Report Export.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#analytics","api_endpoint":"https://api.aircall.io/v1/analytics/report/export/{export_id}"},"summary":"Retrieve an Analytics Report Export","description":"Retrieve the current state of an Analytics report export job. Poll roughly every minute while status is PENDING. On COMPLETED the response includes a presigned, time-limited downloadUrl.","security":[{"bearerAuth":[]}]}},"/v1/outbound-calls/agents/{agent_id}":{"post":{"tags":["AI Voice Agent"],"parameters":[{"name":"agent_id","in":"path","description":"Unique identifier for the Outbound Voice Agent. Found in the Outbound Call Workflow tab of the agent's configuration page.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.aircall.io/api-references#ai-voice-agent","api_endpoint":"https://api.aircall.io/v1/outbound-calls/agents/{agent_id}"},"summary":"Trigger an Outbound Call","description":"Trigger an outbound call from an Outbound (AI) Voice Agent. The agent must be configured in the Aircall Dashboard with a phone number and first message. Per-company concurrency: 5 concurrent calls; per-number: 1. Requests are queued until a slot is available.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_phone":{"type":"string","description":"The phone number to call, with country code. Leading + is optional; spaces, dashes and parentheses are stripped automatically. Mandatory field.","required":true},"idempotency_key":{"type":"string","description":"A unique identifier for this call request. Sending the same key twice will not create a duplicate call. A key cannot be reused even if the original request failed. Mandatory field.","required":true},"context":{"type":"object","description":"Key-value pairs that fill in {{variable}} placeholders in the agent's first message and voicemail message. Every {{variable}} must have a corresponding key or the call is rejected.","properties":{"timezone":{"type":"string","description":"IANA timezone identifier for datetime conversion. Required when a context value is a UTC datetime without an offset."}}},"expiration_seconds":{"type":"number","description":"How long the system keeps trying to place the call if the concurrency limit is reached. Min: 60. Max: 86400 (24 hours). Default: 3600."}}},"example":{"contact_phone":["+15551234567"],"idempotency_key":["appt-reminder-2024-03-15-cust-12345"],"context":[{"first_name":"Jane","appointment_date":"March 20th at 2:00 PM"}],"expiration_seconds":[3600]}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}