Get Engagements by Status

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.

Supports paging (limit, offset), free-text search, and sort (Title, Code, FieldworkStartDate, FieldworkEndDate, DeliverableDueDate, Created, Modified) with optional desc=true.

Modified orders by the most recent activity anywhere in the engagement (requests, documents, and so on),
matching the "Modified" column shown in the portal's engagement lists.

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 engagements matching the specified status filters.

Body

Example

{
    "items": [
        {
            "engagementID": 0,
            "importKey": "string",
            "divisionID": null,
            "companyID": 0,
            "title": "string",
            "code": "string",
            "type": "string",
            "period": "string",
            "year": null,
            "fieldworkStartDate": null,
            "fieldworkEndDate": null,
            "deliverableDueDate": null,
            "ownerID": null,
            "onSchedule": 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"
            },
            "professionalUsers": [
                {
                    "userID": 0,
                    "roleID": 0
                }
            ],
            "clientUsers": [
                {
                    "userID": 0,
                    "roleID": 0
                }
            ],
            "requests": [
                0
            ]
        }
    ],
    "totalCount": 0,
    "limit": 0,
    "offset": 0
}

🟠400

🟠403

Request

Responses