engagements

List

GET
Lists the engagement records.

Query parameters

cursorstringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
external_refstringOptional

Filters for meetings with the provided external_refs.

limitintegerOptional
The maximum number of engagements to return.
membersstringOptional
Filters for engagement of the provided members.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values: afterbefore
parentstringOptional
Filters for engagements with the provided parent.
sort_bystringOptional
Fields to sort the engagements by and the direction to sort them.
typeenumOptional
Filters for engagement of the provided types.

Response

This endpoint returns an object
engagements
list of objects
The list of engagements.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
GET
1curl https://api.devrev.ai/engagements.list \
2     -H "Authorization: <apiKey>"
200
Retrieved
1{
2  "engagements": [
3    {
4      "id": "id",
5      "created_date": "2023-01-01T12:00:00Z",
6      "description": "description",
7      "display_id": "display_id",
8      "modified_date": "2023-01-01T12:00:00Z"
9    }
10  ],
11  "next_cursor": "next_cursor",
12  "prev_cursor": "prev_cursor"
13}
Built with