AuditDashboard Developer Portal
  1. Engagements
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.
  1. Engagements

Get Engagements by Status

GET
/api/public/engagements
Engagements
Retrieves a list of engagements filtered by their status.
Supported StatusIDs:
0 = Draft
10 = In Progress
1 = Complete
-5 = Reopened
If no status is provided, all engagements are retrieved.

Request

Query Params
status
string 
optional
A comma-separated string of StatusIDs to filter engagements.

Responses

🟢200OK
text/plain
OK: Returns a list of engagements matching the specified status filters.
Body
array of:
EngagementID
integer <int32>
optional
Gets the unique identifier for the engagement.
DivisionID
integer <int32> | null 
optional
Gets the identifier for the division associated with the engagement.
CompanyID
integer <int32>
optional
Gets the identifier for the company associated with the engagement.
Title
string  | null 
optional
Gets the title of the engagement.
Code
string  | null 
optional
Gets the code of the engagement.
Type
string  | null 
optional
Gets the type of the engagement.
Period
string  | null 
optional
Gets the period of the engagement.
Year
integer <int32> | null 
optional
Gets the year of the engagement.
StartDate
string <date-time> | null 
optional
Gets the start date of the engagement.
DueDate
string <date-time> | null 
optional
Gets the due date of the engagement.
OwnerID
integer <int32> | null 
optional
Gets the identifier for the owner of the engagement.
GlobalModification
string <date-time>
optional
Gets the global modification timestamp for the engagement.
Status
enum<integer> <int32>
optional
Allowed values:
0110-100-5
Created
object (TrackingInfo) 
optional
By
integer <int32>
optional
On
string <date-time>
optional
Modified
object (TrackingInfo) 
optional
ProfessionalUsers
array[object (APIEngagementUser) {2}]  | null 
optional
Gets the dictionary of professional users associated with the engagement.
The key is the user ID and the value is an optional role identifier.
UserID
integer <int32>
optional
RoleID
integer <int32>
optional
ClientUsers
array[object (APIEngagementUser) {2}]  | null 
optional
Gets the dictionary of client users associated with the engagement.
The key is the user ID and the value is an optional role identifier.
UserID
integer <int32>
optional
RoleID
integer <int32>
optional
Requests
array[integer <int32>] | null 
optional
Gets the list of request identifiers associated with the engagement.
Example
[
  {
    "EngagementID": 0,
    "DivisionID": 0,
    "CompanyID": 0,
    "Title": "string",
    "Code": "string",
    "Type": "string",
    "Period": "string",
    "Year": 0,
    "StartDate": "2019-08-24T14:15:22Z",
    "DueDate": "2019-08-24T14:15:22Z",
    "OwnerID": 0,
    "GlobalModification": "2019-08-24T14:15:22Z",
    "Status": 0,
    "Created": {
      "By": 0,
      "On": "2019-08-24T14:15:22Z"
    },
    "Modified": {
      "By": 0,
      "On": "2019-08-24T14:15:22Z"
    },
    "ProfessionalUsers": [
      {
        "UserID": 0,
        "RoleID": 0
      }
    ],
    "ClientUsers": [
      {
        "UserID": 0,
        "RoleID": 0
      }
    ],
    "Requests": [
      0
    ]
  }
]
🟠400Bad Request
🟠401Unauthorized
Modified at 2025-03-24 12:24:39
Previous
Get Active Divisions
Next
Create Engagements
Built with