1. AuditDashboard API v2
AuditDashboard Developer Portal
  • AuditDashboard API v2
    • AuditDashboard APIs
    • Open API V2 Authentication
    • Clients
      • Get All Clients
      • Create Clients
      • Update Clients
      • Deactivate Clients
      • Activate Clients
      • Client Details
      • Update Client
      • Deactivate Client
      • Activate Client
    • Users
      • /api/v2/query
      • /api/v2/list
      • 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
    • Divisions
      • Get Active Divisions
    • Engagements
      • Get Engagements by Status
      • Create Engagements
      • Update Engagement
      • Update Engagement Statuses
      • Delete Engagements
      • Get My Engagements
      • Get My Overdue Engagements
      • Get Engagements Ready To Complete
      • Get Engagement Details
      • Update Engagement
      • Update Engagement Status
      • Delete Engagement
      • Duplicate Engagement
      • Download Engagement Documents
      • Get Engagement Activity Feed
      • Download Engagement Request Report
      • Download 'All Engagements' Report
    • Files
      • List Containers
      • Create Company Cabinet
      • Set Container Notifications
      • Update Folder
      • Delete Folder
      • List Folders in Container
      • Create Folder
      • List Files in Container Root
      • Upload File to Container
      • List Files in Folder
      • Upload File to Folder
      • Share File or Folder
      • Unshare File or Folder
      • Delete Cabinet
      • Download File
      • Download Folder Contents
      • Create Download Group
    • Insights
      • Get Engagement by Last Activity Report Parameters
      • Engagement by Last Activity
      • User Activity and Status
    • Me
      • Get Current User
    • Requests
      • Get Engagement Requests
      • Get Requests Pending My Review
      • Get My Requests
      • Get My Overdue Requests
      • Get Requests I've Flagged
      • 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
      • Get Mentionable Users for a Request
      • Add Comment to Request
      • Send Files to Engagement
      • Delete a Request Comment
      • Delete a Request Document
      • Download Request Documents
      • Update Multiple Request Restrictions
      • Update Single Request Restrictions
      • Upload Request Document
    • Trash
      • Get Trash Types
      • Get Trash List
      • Restore Trash Items
      • Restore a Trash Item
    • Schemas
      • AccessType
      • AddressFamily
      • AggregateFunction
      • APIActivityFeedPageModel
      • APIBatchItemResult
      • APICompanyCreateModel
      • APICompanyModel
      • APICompanyUpdateModel
      • APIContainerCreateModel
      • APIContainerModel
      • APIDivisionModel
      • APIEngagementAutomationsModel
      • APIEngagementCreateModelV2
      • APIEngagementDuplicateModelV2
      • APIEngagementModelV2
      • APIEngagementMonthlyReportModel
      • APIEngagementStatusUpdateModel
      • APIEngagementSummaryModelV2
      • APIEngagementUpdateAutomationsModel
      • APIEngagementUpdateModelV2
      • APIEngagementUser
      • APIFeedItemModel
      • APIFileModel
      • APIFileTransferRequestModel
      • APIFileTransferResponseModel
      • APIFileTransferResultModel
      • APIFolderCreateModel
      • APIFolderModel
      • APIFolderUpdateModel
      • APIMeDivisionModel
      • APIMeModel
      • APIMentionableUserModel
      • APIMeRoleModel
      • APIRequestCreateModel
      • APIRequestModel
      • APIRequestRestricModel
      • APIRequestUpdateModel
      • APIShareRequestModel
      • APIStatusModel
      • APITrashModel
      • APIUserCreateModel
      • APIUserModel
      • APIUserUpdateModel
      • AsnEncodedData
      • AsymmetricAlgorithm
      • AuthenticationProvider
      • AutomationTrigger
      • BatchItemOutcome
      • CalculationExpression
      • CalculationOperator
      • CancellationToken
      • Claim
      • ClaimsIdentity
      • ClaimsPrincipal
      • ColumnFormatOptions
      • ColumnInfo
      • ConnectionInfo
      • CreateDownloadGroupRequest
      • EngagementNotificationType
      • EngagementStatus
      • ETag
      • FeedItem
      • FeedType
      • FileType
      • HostString
      • HttpContext
      • HttpRequest
      • HttpResponse
      • IFormFile
      • IIdentity
      • IPAddress
      • IResponseCookies
      • IServiceProvider
      • ISession
      • KeySizes
      • KeyValuePairOfstringAndstring
      • KeyValuePairOfstringAndStringValues
      • KeyValuePairOfTypeAndObject
      • MultiFactorType
      • NotificationFrequency
      • ObjectReference
      • Oid
      • PagedResultOfAPICompanyModel
      • PagedResultOfAPIContainerModel
      • PagedResultOfAPIEngagementModelV2
      • PagedResultOfAPIEngagementSummaryModelV2
      • PagedResultOfAPIFileModel
      • PagedResultOfAPIFolderModel
      • PagedResultOfAPIRequestModel
      • PagedResultOfAPIUserModel
      • PathString
      • Permission
      • PermissionList
      • PermissionType
      • PipeReader
      • PipeWriter
      • ProblemDetails
      • PublicKey
      • QueryColumn
      • QueryRequest
      • QueryString
      • ReadOnlyMemoryOfbyte
      • RequestNotificationType
      • RequestStatus
      • SafeWaitHandle
      • SetContainerNotificationsRequest
      • SetContainerNotificationsResponse
      • SqlDbType
      • Stream
      • TableInfo
      • TrackingInfo
      • TrashType
      • Type
      • WaitHandle
      • WebSocketManager
      • X500DistinguishedName
      • X509Certificate2
      • X509Extension
  • AuditDashboard API v1
    • Clients
      • Get All Clients
      • Create Clients
      • Update Clients
      • Deactivate Clients
      • Activate Clients
      • Client Details
      • Update Client
      • Deactivate Client
      • Activate Client
    • Divisions
      • Get Active Divisions
    • Engagements
      • Get Engagements by Status
      • Create Engagements
      • Update Engagement
      • Update Engagement Statuses
      • Delete Engagements
      • Get Engagement Details
      • Update Engagement
      • Update Engagement Status
      • Delete Engagement
      • Download Engagement Documents
      • Download Engagement Request Report
      • Download 'All Engagements' Report
      • /api/public/engagements/{engagementID}/activityFeed
      • /api/public/engagements/{engagementID}/requestlistreportdata
    • Insights
      • Get Engagement Activity Log Parameters
      • Engagement Activity Log
      • Get Engagement by Last Activity Report Parameters
      • Engagement by Last Activity
      • Get Active Professional Users for Schedule
      • User Activity and Status
      • Schedule
    • 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.
    • Files
      • List Containers
      • Set Container Notifications
      • List Folders in Container
      • List Files in Container Root
      • List Files in Folder
      • Share File or Folder
      • Unshare File or Folder
      • Download File
      • Download Folder Contents
      • Create Download Group
    • Schemas
      • Schemas
      • v2
      • v1
      • APICompanyCreateModel
      • APICompanyModel
      • APICompanyUpdateModel
      • APIEngagementActivityLogModel
      • APIContainerModel
      • APIEngagementCreateModel
      • APIEngagementModel
      • APIEngagementMonthlyReportModel
      • APIEngagementUpdateModel
      • APIEngagementUser
      • APIRequestCreateModel
      • APIRequestModel
      • APIFileModel
      • APIRequestRestricModel
      • APIFolderModel
      • APIRequestUpdateModel
      • APIUserCreateModel
      • APITrashModel
      • APIUserModel
      • APIUserUpdateModel
      • AuthenticationProvider
      • APIShareRequestModel
      • ETag
      • EngagementNotificationType
      • EngagementStatus
      • FeedItem
      • FeedType
      • AccessType
      • MultiFactorType
      • AddressFamily
      • NotificationFrequency
      • AsnEncodedData
      • ProblemDetails
      • Assembly
      • RegistrationStatus
      • AsymmetricAlgorithm
      • RequestNotificationType
      • RequestStatus
      • ByteReadOnlyMemory
      • TrackingInfo
      • ByteReadOnlySpan
      • CallingConventions
      • TrashType
      • CancellationToken
      • Claim
      • ClaimsIdentity
      • ClaimsPrincipal
      • ConnectionInfo
      • ConstructorInfo
      • CreateDownloadGroupRequest
      • CustomAttributeData
      • CustomAttributeNamedArgument
      • CustomAttributeTypedArgument
      • EventAttributes
      • EventInfo
      • FieldAttributes
      • FieldInfo
      • FileType
      • GenericParameterAttributes
      • HostString
      • HttpContext
      • HttpRequest
      • HttpResponse
      • ICustomAttributeProvider
      • IIdentity
      • IPAddress
      • IResponseCookies
      • IServiceProvider
      • ISession
      • IntPtr
      • KeySizes
      • LayoutKind
      • MemberInfo
      • MemberTypes
      • MethodAttributes
      • MethodBase
      • MethodImplAttributes
      • MethodInfo
      • Module
      • ModuleHandle
      • Oid
      • ParameterAttributes
      • ParameterInfo
      • PathString
      • PipeWriter
      • PropertyAttributes
      • PropertyInfo
      • PublicKey
      • QueryString
      • RuntimeFieldHandle
      • RuntimeMethodHandle
      • RuntimeTypeHandle
      • SafeWaitHandle
      • SecurityRuleSet
      • SetContainerNotificationsRequest
      • SetContainerNotificationsResponse
      • StringStringKeyValuePair
      • StringStringValuesKeyValuePair
      • StructLayoutAttribute
      • Type
      • TypeAttributes
      • TypeInfo
      • TypeObjectKeyValuePair
      • WaitHandle
      • WebSocketManager
      • X500DistinguishedName
      • X509Certificate2
      • X509Extension
  1. AuditDashboard API v2

AuditDashboard APIs

The AuditDashboard APIs provide secure, programmatic access to your portal: clients, engagements, requests, users, files, insights, and trash. Use our APIs to automate the work your team does by hand, keep AuditDashboard in step with your other systems, and pull your engagement data out for reporting.
It is also built for AI agents. The v2 API doubles as a hosted MCP endpoint, so tools like Claude, ChatGPT, and Copilot can work in your portal directly, within the permissions of the person they are acting for.

What you can do#

Create and maintain client companies, one at a time or in bulk.
Set up audit engagements and keep their statuses, assignments, and details current.
Raise requests, track them through their workflow, and see where each one stands.
Move files in and out of the portal, and share them where sharing is allowed.
Pull engagement and user activity data for reporting.
Find deleted items and put them back.
Add users and manage their roles and permissions.
Common starting points: create next year's engagements from your practice management system, push a request list in from a template, pull request status into a dashboard, or move client files without anyone touching a browser.

Choosing a version#

Two versions of the API are documented on this site.
v2 (/api/v2) is the current API and where all new integrations should be built. It covers everything v1 does and adds current-user (/me) dashboards, engagement duplication, Secure File Sharing, consistent list pagination and sorting, searchable queries, and standardized error responses.
v1 (/api/public) is in maintenance mode. It receives no new features and stays live so existing integrations keep working. It will be retired at a future date.
Pick v2 unless you are maintaining an integration already built against /api/public. Agentic work needs v2: the portal's MCP endpoint is generated from the v2 surface, so anything you can do with the v2 API is something an agent can do too, and only the tools a given user is permitted to use are offered to them.
Each version's section in the navigation has its own introduction and endpoint reference.

How it works#

Every request is made over HTTPS to your own portal (https://yourcompany.auditdashboard.com) and carries a bearer token.
The API acts as the identity behind that token and sees exactly what that identity is permitted to see, so the same permission rules that apply in the portal apply to your integration, and to any agent connected to it. Requests and responses are JSON, list endpoints are paged, and errors come back in a consistent, documented shape.
The authentication page under your chosen version walks through obtaining and refreshing a token once access is arranged.

Rate Limits#

To ensure optimal performance, the API enforces a rate limit of 20 requests per second. For higher limits, contact support@auditdashboard.com.

Getting access#

API access is enabled per portal and set up with our team, so the first step is to talk to us.
Email support@auditdashboard.com and include:
Your portal – the subdomain you use to sign in (the yourcompany in yourcompany.auditdashboard.com).
Who you are – your name, your firm, and your role.
What you want to build – the workflow you are trying to automate, the system you want to connect, or the agent you want to give access to.
We will get back to you to confirm access and set up a short call if you wish. We can point you at the right endpoints, send you a Postman collection and code samples, and answer questions as you build.

Explore while you wait#

You do not need access to read the reference. Use the navigation on the left to browse the endpoints, parameters, and sample payloads for each version and sketch out your integration.

Need help?#

We're committed to your success. 🚀
Visit www.auditdashboard.com/help or email support@auditdashboard.com.
Modified at 2026-09-09 22:19:10
Next
Open API V2 Authentication
Built with