Get Engagement Requests - AuditDashboard Developer Portal

Retrieves a list of requests for a specific engagement, optionally filtered by status.

If status is provided, requests are filtered by the specified status IDs.

If omitted, all requests for the engagement are retrieved.

The user must have permissions to view the requests.

Supports paging (limit, offset) and sort (Title, Reference, DueDate, GlobalModification, DocumentCount, CommentCount) with optional desc=true.

search filters by free text across the request's default search fields.

flagged filters to requests the calling user has flagged (flags are per-user). Only true has an effect — a never-opened request has no flag row, so false can't tell it apart from a deliberately unflagged one.

highPriority filters to (or excludes) requests marked High Priority.

restricted filters to (or excludes) requests with restricted access.

overdue filters to Outstanding/Returned requests past their due date (matches GET /api/v2/me/requests/overdue). Only true has an effect.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200

application/json

OK: Returns a list of requests for the specified engagement.

Body

Example

{
    "items": [
        {
            "title": "string",
            "reference": "string",
            "requestID": 0,
            "importKey": "string",
            "engagementID": 0,
            "description": "string",
            "dueDate": null,
            "highPriority": true,
            "sendEmailImmediately": null,
            "firmUserID": null,
            "clientUserID": null,
            "restricted": true,
            "excludeFromDuplication": true,
            "globalModification": "2019-08-24T14:15:22.123Z",
            "status": {
                "value": 0,
                "name": "string"
            },
            "created": {
                "by": 0,
                "on": "2019-08-24T14:15:22.123Z"
            },
            "modified": {
                "by": 0,
                "on": "2019-08-24T14:15:22.123Z"
            },
            "access": [
                0
            ],
            "comments": [
                0
            ],
            "documents": [
                0
            ],
            "documentCount": 0,
            "commentCount": 0
        }
    ],
    "totalCount": 0,
    "limit": 0,
    "offset": 0
}

🟠400

🟠403

🟠404