List room participant

GET /v1/Rooms/{RoomSid}/Participants

Participants in video rooms

Path parameters

  • RoomSid string Required

    The SID of the room with the Participant resources to read.

Query parameters

  • Status string

    Read only the participants with this status. Can be: connected or disconnected. For in-progress Rooms the default Status is connected, for completed Rooms only disconnected Participants are returned.

    Values are connected or disconnected.

  • Identity string

    Read only the Participants with this User identity value.

  • DateCreatedAfter string(date-time)

    Read only Participants that started after this date in ISO 8601 format.

  • DateCreatedBefore string(date-time)

    Read only Participants that started before this date in ISO 8601 format.

  • 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 SID of the Account that created the resource

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

      • date_created string(date-time) | null

        The ISO 8601 date and time in GMT when the resource was created

      • date_updated string(date-time) | null

        The ISO 8601 date and time in GMT when the resource was last updated

      • duration integer | null

        Duration of time in seconds the participant was connected

      • end_time string(date-time) | null

        The time when the participant disconnected from the room in ISO 8601 format

      • identity string | null

        The string that identifies the resource's User

      • links object(uri-map) | null

        The URLs of related resources

      • room_sid string | null

        The SID of the participant's room

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

      • sid string | null

        The unique string that identifies the resource

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

      • start_time string(date-time) | null

        The time of participant connected to the room in ISO 8601 format

      • status string | null

        The status of the Participant

        Values are connected or disconnected.

      • url string(uri) | null

        The absolute URL of the resource
GET /v1/Rooms/{RoomSid}/Participants 
curl \
 -X GET https://video.twilio.com/v1/Rooms/{RoomSid}/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",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "duration": 42,
      "end_time": "2023-05-04T09:42:00+00:00",
      "identity": "string",
      "links": {},
      "room_sid": "string",
      "sid": "string",
      "start_time": "2023-05-04T09:42:00+00:00",
      "status": "connected",
      "url": "https://example.com"
    }
  ]
}