Skip to main content

Dash API

Learn how to set up, authorize, and securely use the Dash API with endpoints, filters, examples, and best practices.

Angel Horowitz avatar
Written by Angel Horowitz
Updated over 2 weeks ago

πŸ“ 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


πŸ”‘ 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.


πŸ› οΈ Getting Started

πŸ—οΈ Creating an API Key

Click the arrow to learn how to generate an API key

  1. From the Global Search, type in API Keys

  2. Click + New API Key

  3. Assign a descriptive name and choose the role for key permissions

  4. 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.

πŸ”’ Security & Permissions

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

  • 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

Did this answer your question?