engagements

List Post

POST
Lists the engagement records.

Request

This endpoint expects an object.
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
external_ref
list of stringsOptional

Filters for meetings with the provided external_refs.

limit
integerOptional
The maximum number of engagements to return.
members
list of stringsOptional
Filters for engagement of the provided members.
mode
enumOptional
The iteration mode to use. If "after", then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If "before", then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.
Allowed values: afterbefore
parent
list of stringsOptional
Filters for engagements with the provided parent.
sort_by
list of stringsOptional
Fields to sort the engagements by and the direction to sort them.
type
list of enumsOptional
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.
POST
1curl -X POST https://api.devrev.ai/engagements.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200
Successful
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