Sign in
ConversationsV2Participant

List Participants

Retrieve a list of Participants in a Conversation.

get/v2/Conversations/{ConversationId}/Participants

Query parameters

pageSizeinteger
Example:50

Maximum number of items to return

pageTokenstring

Page token for pagination

Response

OK

Example response

{
  "participants": [
    {
      "id": "conv_participant_00000000000000000000000001",
      "conversationId": "conv_conversation_00000000000000000000000001",
      "accountId": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "name": "Dana",
      "type": "CUSTOMER",
      "profileId": "mem_profile_00000000000000000000000000",
      "addresses": [
        {
          "channel": "SMS",
          "address": "+18005550100"
        },
        {
          "channel": "WHATSAPP",
          "address": "whatsapp:+18005550100"
        },
        {
          "channel": "RCS",
          "address": "rcs:+18005550100"
        }
      ],
      "createdAt": "2023-07-01T12:00:00Z",
      "updatedAt": "2023-07-01T12:30:00Z"
    }
  ],
  "meta": {
    "key": "participants"
  }
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.