AuditDashboard Developer Portal
  1. Requests
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
  • 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
  • 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
    • Schedule
    • User Activity and Status
  • Requests
    • Get Engagement Requests
      GET
    • Get Request by ID
      GET
    • Update Request Details
      PUT
    • Update Request Status and Priority
      PATCH
    • Delete Request
      DELETE
    • Create Requests
      POST
    • Update Multiple Requests
      PUT
    • Update Request Status and Priority
      PATCH
    • Delete Multiple Requests
      DELETE
    • Get Request History Feed
      GET
    • Get Request Activity Feed
      GET
    • Add Comment to Request
      POST
    • Delete a Request Comment
      DELETE
    • Delete a Request Document
      DELETE
    • Download Request Documents
      GET
    • Update Multiple Request Restrictions
      PATCH
    • Update Single Request Restrictions
      PATCH
    • Upload Request Document
      POST
  • 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. Requests

Get Request by ID

GET
/api/public/requests/{requestID}
Requests
Retrieves a specific request by its unique ID.

Request

Path Params
requestID
integer <int32>
required
The ID of the request to retrieve.

Responses

🟢200OK
text/plain
OK: The request was retrieved successfully.
Body
RequestID
integer <int32>
optional
Gets the unique identifier for the request.
EngagementID
integer <int32>
optional
Gets the engagement ID associated with the request.
Title
string  | null 
optional
Gets the title of the request.
Reference
string  | null 
optional
Gets the reference code for the request.
Description
string  | null 
optional
Gets the description of the request.
DueDate
string <date-time> | null 
optional
Gets the due date for the request.
HighPriority
boolean 
optional
Gets whether the request is marked as high priority.
SendEmailImmediately
boolean  | null 
optional
Gets whether an email should be sent immediately.
FirmUserID
integer <int32> | null 
optional
Gets the firm user ID associated with the request.
ClientUserID
integer <int32> | null 
optional
Gets the client user ID associated with the request.
Restricted
boolean 
optional
Gets whether the request is restricted.
ExcludeFromDuplication
boolean 
optional
Gets whether the request should be excluded from duplication.
GlobalModification
string <date-time>
optional
Gets the global modification timestamp.
Status
enum<integer> <int32>
optional
Allowed values:
0110-100-1
Created
object (TrackingInfo) 
optional
By
integer <int32>
optional
On
string <date-time>
optional
Modified
object (TrackingInfo) 
optional
Access
array[integer <int32>] | null 
optional
Gets the list of user IDs who have access to the request.
Comments
array[integer <int32>] | null 
optional
Gets the list of comment IDs associated with the request.
Documents
array[integer <int32>] | null 
optional
Gets the list of document IDs associated with the request.
Example
{
  "RequestID": 0,
  "EngagementID": 0,
  "Title": "string",
  "Reference": "string",
  "Description": "string",
  "DueDate": "2019-08-24T14:15:22Z",
  "HighPriority": true,
  "SendEmailImmediately": true,
  "FirmUserID": 0,
  "ClientUserID": 0,
  "Restricted": true,
  "ExcludeFromDuplication": true,
  "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"
  },
  "Access": [
    0
  ],
  "Comments": [
    0
  ],
  "Documents": [
    0
  ]
}
🟠401Unauthorized
🟠404Record Not Found
Modified at 2025-03-24 12:24:39
Previous
Get Engagement Requests
Next
Update Request Details
Built with