Skip to main content

ListParticipants retrieves engagement participants.

GET 
/api/v1/engagements/:engagementId/participants

Returns all participants in an engagement. By default, excludes participants who have left.

Filtering​

  • participant_type: Filter by type (AGENT, CONTACT, etc.)
  • include_left: Include departed participants

Errors​

  • NOT_FOUND: Engagement does not exist
  • PERMISSION_DENIED: Caller lacks engagement:read permission

Request​

Responses​

A successful response.