Public API
TL;DR: Uku's Public API lets you query data, build custom integrations, and create clients and contacts programmatically. Activate it from Settings and Apps, generate API keys, and start making requests using the API documentation.
Who can do this
Users with admin permissions in Uku
Overview
Uku's public API offers a variety of endpoints that allow you to:
Perform data queries -- Retrieve the necessary information for your internal reporting.
Build integrations -- If Uku lacks integration with a tool you need, you can create and use it yourself.
Create clients and contacts -- Add new clients and contacts directly into Uku.
Full reference: Uku API Documentation.
How to set up the Uku API
Open Settings and Apps from the main menu.
Locate Public API and click on it.
Click the Activate button to enable API access.
Confirm that the application status changes to Active.
Generating API keys
In the API Integration section, click on the Settings tab.
Enter a name for the key (e.g., "Software Name").
Click Generate New API Key.
Click Save.
The key name, API key, and API secret key are now displayed. Hover over each field to reveal a copy icon for copying the values.
The API key and API secret are automatically generated as random combinations of letters and numbers. They cannot be edited for security reasons.
Deleting API keys
Select the key you wish to delete.
Hover over the API key row to reveal the delete icon.
Click the delete icon.
Confirm deletion in the confirmation dialog.
Deleting a key removes both the API key and the corresponding API secret.
API application status
If the API application is deactivated, all keys change from active to inactive.
When the application is reactivated, previous keys become active again.
Troubleshooting
API requests return 401 Unauthorized: Verify that the API application status is Active and that you are using the correct API key and API secret. Keys become inactive when the application is deactivated.
Cannot find Public API in Settings: Ensure you have admin permissions. The Public API option is only visible to admin users under Settings and Apps.
Accidentally deleted an API key: Deleted keys cannot be recovered. Generate a new API key and update any integrations that relied on the old key.
Keys showing as inactive after reactivation: Deactivating and reactivating the API app should restore previous keys. If keys remain inactive, try generating new ones and updating your integrations.