How to Create and Manage Company API Keys
This document provides instructions on how to create and manage Company API Keys.
Created: September 2025
Updated: October 2025
Permalink: https://wildix.atlassian.net/wiki/x/dAANWw
Introduction
API Keys are unique authentication tokens that let your applications access Wildix services without the need for user login credentials. They can be used for:
Server-to-server integrations
Automated scripts and workflows
Third-party applications
Background services
API Keys offer a secure way for authenticating your applications when interacting with Wildix APIs. This guide explains how to create, manage, and use API Keys effectively.
Requirements
WMS 7.04.20250929.2 and higher
Root admin access
How to Create API Key
Go to WMS → PBX → Integrations → Company API Keys:
Click Create API Key
Enter the name of your API Key, which would help you identify the necessary API Key, especially if you have multiple items.
Choose expiration time
The minimum lifetime of an API Key 1 hour, the maximum – 12 months.
If expiration date is not chosen, 1 year expiration is set by default.
Select the permissions of the API Key. Here you have the following options:
Global Development Access: provides full access to any APIs and operations.
It is recommended to use only for development purposes, not in production. The maximum lifetime of a token with global development access is 7 days.
Access to a section (e.g. Messaging, Users, Kite, etc.), where in some case you can choose between full access to all operations (1) or read-only operations (2):
Access to specific operations only: in the necessary section, navigate to the Specific by Operation tab and choose the operations you need the API key for:
Note: In our API documentation, for each operation that uses API Key authentication, you can view the list of applicable scopes. For example:
You can also use the Search field to look for specific operations:
After you select the necessary operations, click Create API Key:
The API Key gets created. On the screen that shows up, you can view the API Key details:
Name
Scopes
API Key Value, which has to be copied and saved
Important: Make sure to copy the API Key and keep it safe, as this is the only time you will see the full API key.
The API Key is then displayed in the list of API Keys on the Company API Keys tab:
How to manage API Keys
View API Keys list
You can view all API Keys on the Company API Keys tab. There, you can the following information:
API Key name
Scopes: hovering the mouse on the number, you can see the scope details
First 3 characters of the API Key
Date the key was created
Expiration data
In case an API Key has already expired, its color is red and it is marked Expired next to the API Key name:
Edit an API Key
It is possible to edit only the name of an API Key. Expiration date or scopes cannot be modified.
To change scopes or expiration, you need to create a new API Key.
Click the pencil icon next to the relevant API Key:
Modify the API Key name and click Edit:
Delete an API Key
Click on the delete icon next to the necessary API Key:
Click Delete to confirm the deletion:
Expiration Emails
An admin gets email notification upcoming Company API Key expiration. The email is sent every day at 11:00 UTC and includes:
Company API Keys that expired in the past 24 hours
API Keys that are about to expire within the next 7 days
Usage Example
You can use Company API Keys right in our API documentation. For this, enter API Key with the necessary access scope permissions in the Token field, provide other details (e.g. channelId, etc.) and click Send API Request to view the results.