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 keys created for your organisation.
Each API key row may show:
API key name
Key ID or short key reference
Environment label, such as test
Status label, such as Revoked
Created date
Creator name
Last used status
Creator avatar
Options menu
Example API key names shown include:
Invoice Integration API
Roster Sync API
Payroll Export API
Use this list to check which API keys exist, who created them, and whether they are still active, unused, or revoked.
Search API Keys
Use the Search keys field to find a specific API key.
This is useful when your organisation has multiple keys and you need to locate one by name or key reference.
Filter and Sort API Keys
Use the dropdowns above the key list to narrow or organise the results.
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 review or sort keys based on when they were created.
Create an API Key
Click Create API key.
A Create API key drawer opens on the right side of the page.
This drawer lets you create a new key and control what the key can access.
Enter the API Key Details
Complete the fields in the Create API key drawer.
Name
Enter a clear name for the 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 workspace.
Expires In
Enter how long the key should remain valid.
The field may show Never by default.
Use an expiry period if 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 scope.
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
Add or remove users from roles
Archive or un-archive users
Block or un-block users
Reset users passwords
Reset users multi-factor authentication
Each scope may also show a permission code, such as:
read
write
read
write
Important: 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.
Copy the API key secret immediately and store it securely.
Do not share the secret in public channels, screenshots, emails, or unsecured documents.
If the secret is lost, you may need to create 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: 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.
Use the API Documentation Link
At the bottom of the Create API key drawer, you may see a link to the API documentation.
Use this link if you need technical guidance for connecting an integration or using the Diversity Sync API.
Understanding API Key Status
API keys may show status labels.
Examples include:
Revoked
A revoked key should no longer be used for API access.
If an integration stops working, check whether the API key has been revoked, expired, or replaced.
Important Notes
API keys provide programmatic access to the Diversity Sync API.
Treat API keys like passwords.
The API key secret is shown once only.
Use Test keys for testing and development.
Use Live keys only for production use.
Select the minimum scopes required.
Revoke or replace keys that are no longer needed.
Check Last used to identify keys that may be unused.
Store API key secrets securely.
Troubleshooting
If you cannot see the API Keys tab:
Confirm you are in Admin.
Ask an administrator to check your role permissions.
Refresh the page and try again.
If you cannot create an API key:
Make sure the Name field is completed.
Check that the correct Environment is selected.
Select the required Scopes.
Confirm that you have permission to create API keys.
Refresh the page and try again.
If the Create key button is disabled:
Enter a key name.
Select at least one scope.
Check that all required fields are complete.
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.
If you lost the secret value:
Create a new API key.
Update the integration with the new secret.
Revoke the old key if it is no longer needed.