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.

mode"after" or "before"Optional

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.
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.