AuditDashboard Developer Portal
Overview#
The AuditDashboard Open API provides secure and programmatic access to manage clients, engagements, engagement documents, requests, users, trash, and insights. Designed for seamless integration, the API enables automation and data retrieval across key areas of the AuditDashboard platform.We're committed to your success. For code samples, and dedicated integration support, please reach out. We're here to help you get started quickly and maximize the power of the AuditDashboard Open API.API Endpoints#
Clients API – Create, update, and manage client companies individually or in bulk.
Engagements API – Manage audit engagements, including statuses, assignments, updates, and extract, transform and load files saved in request lists.
Requests API – Handle engagement-related requests, including creation, retrieval, updates, file downloads, and workflow tracking.
Users API – Manage user accounts, roles, and permissions.
Files API – A set of APIs for customers that subscribe to our File Sharing Portal.
Insights API – Retrieve and download insights and client-related data individually or in bulk.
Trash API – List items in trash, permanently delete, or restore items.
Authentication#
The AuditDashboard Open API utilizes a secure two-step authentication process to protect your data. First, you'll need to obtain a bearer token using your API Key and Service Account credentials. Think of this like getting a special keycard to access our system.To get started, gather the following:Service Account Email: The email for your dedicated service account.
Service Account Password: The password for your service account.
Tenant Subdomain: Your company's subdomain in the AuditDashboard URL (e.g., yourcompany in yourcompany.auditdashboard.com).
API Suffix: Any suffix used in your API's URL. (Generally .com)
/api/account/serviceToken) and exchange these credentials for a bearer token. This token, like that keycard, grants access to the rest of the API's features, allowing you to manage clients, engagements, engagement documents, requests, users, and reports.Our Postman Collection parameterizes all this for you. Request it today.Getting Started#
1.
Obtain API Credentials – Contact your account representative to set up an API Service account and receive your API Key, Username, and Password.
2.
Explore the API – Explore the developer documentation by using the navigation on the left.
3.
Integrate with Sample Requests – Reference our sample requests to streamline implementation.
Rate Limits#
To ensure optimal performance, the API enforces a rate limit of 20 requests per second. For higher limits, contact support@auditdashboard.com.Need Help?#
Modified at 2026-09-02 03:36:44
