API Referenceengagements

List Engagements

Beta
Lists the engagement records.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

cursorstringOptionalformat: "text"
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.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values:
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.
typelist of enumsOptional
Filters for engagement of the provided types.

Response

Success.
engagementslist of objects
The list of engagements.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors