AuditDashboard Developer Portal
    AuditDashboard Developer Portal
    • AuditDashboard Developer Portal
    • Clients
      • Get All Clients
        GET
      • Create Clients
        POST
      • Update Clients
        PUT
      • Deactivate Clients
        DELETE
      • Activate Clients
        PATCH
      • Client Details
        GET
      • Update Client
        PUT
      • Deactivate Client
        DELETE
      • Activate Client
        PATCH
    • Divisions
      • Get Active Divisions
        GET
    • Engagements
      • Get Engagements by Status
        GET
      • Create Engagements
        POST
      • Update Engagement
        PUT
      • Update Engagement Statuses
        PATCH
      • Delete Engagements
        DELETE
      • Get Engagement Details
        GET
      • Update Engagement
        PUT
      • Update Engagement Status
        PATCH
      • Delete Engagement
        DELETE
      • Download Engagement Documents
        GET
      • Download Engagement Request Report
        GET
      • Download 'All Engagements' Report
        GET
    • Insights
      • Get Engagement Activity Log Parameters
        GET
      • Engagement Activity Log
        POST
      • Get Engagement by Last Activity Report Parameters
        GET
      • Engagement by Last Activity
        POST
      • Get Active Professional Users for Schedule
        GET
      • Schedule
        POST
      • User Activity and Status
        POST
    • Requests
      • Get Engagement Requests
      • Get Request by ID
      • Update Request Details
      • Update Request Status and Priority
      • Delete Request
      • Create Requests
      • Update Multiple Requests
      • Update Request Status and Priority
      • Delete Multiple Requests
      • Get Request History Feed
      • Get Request Activity Feed
      • Add Comment to Request
      • Delete a Request Comment
      • Delete a Request Document
      • Download Request Documents
      • Update Multiple Request Restrictions
      • Update Single Request Restrictions
      • Upload Request Document
    • Users
      • Get Users by Status
      • Create Users
      • Update Multiple Users
      • Deactivate Users
      • Activate Users
      • Get User Details
      • Update User Details
      • Deactivate User
      • Activate User
      • Invite Users
      • Generate User Activity Report
    • Authorization
      • Authorization call for Bearer Token
    • Trash
      • Get Trash Types
      • Get Trash List
      • Restore Trash Items
      • Permanently deletes trash items.
      • Restore a Trash Item
      • Permanently deletes a trash item.

    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.
    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:
    API Key: Your unique key to access the API (contact us at support@auditdashboard.com to get yours).
    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)
    With these in hand, you can make a request to our token endpoint (/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.
    4.
    Download Postman Collection – contact support@auditdashboard.com

    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?#

    For further assistance, contact support@auditdashboard.com. 🚀
    Modified at 2025-03-04 21:16:18
    Next
    Get All Clients
    Built with