Retrieve a list of all participants of the conversation

GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants

A Service Participant resource represents a member of the conversation within a specific service.

Retrieve a list of all participants of the conversation

Path parameters

Query parameters

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • meta object
      Hide meta attributes Show meta attributes
    • participants array[object]
      Hide participants attributes Show participants attributes
      • account_sid string | null

        The unique ID of the Account responsible for this participant.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • attributes string | null

        An optional string metadata field you can use to store any data you wish.

      • chat_service_sid string | null

        The SID of the Conversation Service that the resource is associated with.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

      • conversation_sid string | null

        The unique ID of the Conversation for this participant.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.

      • date_created string(date-time) | null

        The date that this resource was created.

      • date_updated string(date-time) | null

        The date that this resource was last updated.

      • identity string | null

        A unique string identifier for the conversation participant as Conversation User.

      • last_read_message_index integer | null

        Index of last “read” message in the Conversation for the Participant.

      • last_read_timestamp string | null

        Timestamp of last “read” message in the Conversation for the Participant.

      • messaging_binding

        Information about how this participant exchanges messages with the conversation.

      • role_sid string | null

        The SID of a conversation-level Role to assign to the participant

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.

      • sid string | null

        A 34 character string that uniquely identifies this resource.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MB[0-9a-fA-F]{32}$.

      • url string(uri) | null

        An absolute URL for this participant.
GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants 
curl \
 -X GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "participants": [
    {
      "account_sid": "string",
      "attributes": "string",
      "chat_service_sid": "string",
      "conversation_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "identity": "string",
      "last_read_message_index": 42,
      "last_read_timestamp": "string",
      "role_sid": "string",
      "sid": "string",
      "url": "https://example.com"
    }
  ]
}