API Access
Required Role
API_CREDENTIALS permission — Global roles only
The API Access page allows you to generate and manage API tokens that enable programmatic access to your Agent Manager data. Use the API to build custom integrations, automate workflows, or connect with third-party tools.
What the API Allows
With an API token you can:
- Read and write client data
- Create and update applications
- Retrieve reports and statistics
- Trigger notifications
- Sync data with external systems
Generating an API Token
- Click Generate New Token
- Enter a descriptive name for the token (e.g. "Xero Integration", "Website Contact Form")
- Set the token's permission scope (read-only, read-write, admin)
- Set an expiry date (optional) — leave blank for a non-expiring token
- Click Generate — the token is shown once — copy and store it securely
warning
API tokens are shown only once at creation. If you lose a token, you will need to generate a new one.
Managing Tokens
| Action | Description |
|---|---|
| View | See token metadata (name, created, expiry, last used) |
| Revoke | Immediately invalidate a token |
| Regenerate | Replace with a new token value |
API Documentation
Full API documentation is available in your organisation's developer portal. Contact your Agent Manager administrator for the API base URL and documentation link.