List Engagements

This API requires the Agent role.

Gets a list of Engagements by querying by their Engagement ids. The Engagements are returned in the same order as the ids are supplied.

Only Engagements that can be found will be included in the resulting response. If none of the Engagements can be found, then a 404 Not Found response will be returned instead.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 6 and 6

The unique 6 character internal id that represents the customer account.

Query Params
int32
1 to 50
Defaults to 50

The maximum number of results per page.

int32
≥ 1
Defaults to 1

The target page of results.

engagementIds
array of strings
required
length between 1 and 50

A comma-separated list of Engagement id's.

engagementIds*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json