List Post

POST

Lists the engagement records.

Request

This endpoint expects an object.
typelist of enumsOptional

Filters for engagement of the provided types.

cursorstringOptional

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

external_reflist of stringsOptional

Filters for meetings with the provided external_refs.

limitintegerOptional

The maximum number of engagements to return.

memberslist of stringsOptional

Filters for engagement of the provided members.

mode"after" or "before"Optional
Allowed values: afterbefore

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.

parentlist of stringsOptional

Filters for engagements with the provided parent.

sort_bylist of stringsOptional

Fields to sort the engagements by and the direction to sort them.

Response

This endpoint returns an object.
engagementslist of objects

The list of engagements.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.