📝 Overview
The Dash API provides developers and administrators with a way to access, query, and extend data from the software. It follows the JSON:API Specification and supports operations such as filtering, pagination, and relations.
The API is best suited for:
Pulling data into external reporting tools
Automating exports
Building lightweight integrations
It is not designed for bulk/batch updates or extremely high-volume transactional activity.
📚 Helpful Links
Dash API Reference & Documentation – includes a list of available endpoints, details about custom request parameters, and information on feature modules.
🔑 Authorizations
Click the arrow to learn about required authorizations
Click the arrow to learn about required authorizations
To create, edit, or manage API keys, staff members must have the API Key Management authorization assigned to their role.
⚠️ Without this authorization, users cannot access the API Key Management screen.
🛠️ API Key Setup & Management
🗝️ Creating an API Key
Click the arrow to learn how to generate an API key
Click the arrow to learn how to generate an API key
From the Global Search, type in API Keys
Click + Create
Enter a descriptive name and choose the role for key permissions
Copy and securely store the generated key (you will not see it again)
🔒 Security Note: Keys inherit the authorizations of their assigned role. Apply least privilege whenever possible.
✏️ Editing & Deleting an API Key
Click the arrow to learn how to manage existing API keys
Click the arrow to learn how to manage existing API keys
Editing an API Key
From the API Key page, locate the appropriate key.
Click the ⋮ (three dots) menu
Select Edit to update the name or assigned role
Deleting an API Key
Click the ⋮ menu on the key
Select Delete
Confirm the deletion
Additional Options
Click More Details beneath a key for additional information
Use Show Expired Keys or Show Deleted Keys toggles at the top right if needed
🔒 Security & Permissions
Click the arrow to learn about API key security
Click the arrow to learn about API key security
Treat API keys like passwords — store them securely
Rotate keys if compromised or when staff leave
Keys expire only when manually disabled or deleted
Never share keys over email. Instead, use a secure tool like One Time Secret to transmit credentials safely
If you suspect a key has been compromised, delete it immediately and create a new one
⚠️ Limitations & Performance Considerations
Click the arrow to learn about API limits
Click the arrow to learn about API limits
Paging limit: Maximum of 100 results per page
No batch updates: Only single-record modifications are supported
Performance: Large collections may return slowly; use filters and pagination
Permissions restricted: API keys cannot exceed the role’s assigned authorizations