Go to Admin > API Keys
From the left navigation menu, click Admin.
At the top of the Admin page, click API Keys.
The API Keys page is used to create and manage keys for programmatic access to the Diversity Sync API.
Review Existing API Keys
The API Keys page shows the API keys created for your organisation.
Each API key row may show:
API key name
Key ID or short key reference
Environment label
Status label, such as Revoked
Created date
Creator name
Last used status
Creator avatar
Options menu
Use this list to check which API keys exist, who created them, and whether they are still active or revoked.
Search API Keys
Use the Search keys field to find a specific API key.
This is helpful when your organisation has multiple keys and you need to locate one by name or key reference.
Filter and Sort API Keys
Use the available dropdowns to narrow or organise the key list.
Available options shown include:
All creators
Date created
Use All creators to filter keys by the staff member who created them.
Use Date created to sort or review keys based on when they were created.
Create an API Key
Click Create API key.
A Create API key drawer will open on the right side of the page.
This drawer is used to create a new key and control what it can access.
Enter the API Key Details
Complete the following fields:
Name
Enter a clear name for the API key.
Example:
Payroll export
Use a name that describes what the key will be used for.
Environment
Choose the environment for the key.
Available options shown are:
Live
Test
Use Test for testing or development.
Use Live only when the key is ready to be used in the live system.
Expires in days
Enter how long the key should remain valid.
The field may show Never by default.
Use an expiry period when the key is only needed temporarily.
Select Scopes
Scopes control what the API key can access or do.
Use the Filter scopes field to search for a specific permission.
You can select scopes one by one, or click Select all if the key needs all available scopes.
Examples of scopes shown include:
View organisation API keys
Create and revoke organisation API keys
View the users tab in the admin panel
Create invites for new users
Important note:
You can only grant permissions that you currently hold.
Only select the scopes the API key actually needs.
Create the Key
After entering the key details and selecting the required scopes, click Create key.
If the button is disabled, check that the required fields have been completed.
After the key is created, the secret value may be shown only once.
Important:
Copy the API key secret immediately.
Store it securely.
Do not share it in public channels, screenshots, emails, or unsecured documents.
If the secret is lost, it may need to be replaced with a new API key.
Manage an Existing API Key
Click the three-dot menu beside an API key to view available actions.
The available action shown is:
Copy key ID
Use Copy key ID when you need the key identifier for reference, troubleshooting, or integration setup.
Important note:
Copying the key ID is not the same as copying the secret API key.
Secret values are only shown once when the key is created.
Understanding API Key Status
API keys may show a status label.
For example:
Revoked
A revoked key should no longer be used for API access.
If an integration stops working, check whether the key has been revoked or replaced.
Important Notes
API keys provide programmatic access to the Diversity Sync API.
Treat API keys like passwords.
Only create API keys for approved integrations or developer use.
Use the minimum scopes needed.
Revoke or replace keys that are no longer required.
Check the Last used status to identify unused keys.
Store API key secrets securely because they may only be shown once.
Troubleshooting
If you cannot see the API Keys tab:
Confirm that you are in Admin.
Ask an administrator to check your role permissions.
If you cannot create an API key:
Make sure the Name field is completed.
Check that the correct environment is selected.
Select at least the required scopes.
Confirm that you have permission to create API keys.
Refresh the page and try again.
If an API integration stops working:
Check whether the API key is marked as Revoked.
Confirm that the correct key ID is being used.
Check whether the key has expired.
Review the selected scopes.
Create a new key if the original secret is no longer available.