---
title: "Get all participants of a room"
method: GET
path: "/v2/rooms/{room_id}/participants"
tags: ["Room"]
---

# Get all participants of a room

`GET /v2/rooms/{room_id}/participants`

## Request

- Base URL: `https://api.sandbox.eu.bandyer.com`
- URL: `https://api.sandbox.eu.bandyer.com/v2/rooms/{room_id}/participants`
- Auth: API key in header `apikey`

Get a list of participants of a room by its Id.

## Path parameters

- `room_id` string, required

## Query parameters

- `is_admin` boolean

## Response `200`

- object
  - `id` string
  - `participants` object[]
    - `user_id` string: User id of the participant.
    - `url` string, nullable: Call url of the participant.
    - `is_admin` boolean: Indicates if a participant is admin or not.
    - `tools` object
      - `chat` boolean: Enable the chat feature
      - `screen_sharing` boolean: Enable the screen_sharing feature
      - `file_upload` boolean: Enable the capability to send file
      - `snapshot` boolean: Enable the snapshot feature
      - `live_edit` boolean: Enable the live edit feature
      - `live_pointer` boolean: Enable to send pointer-events to others participants (always active in reception)
      - `present_to_everyone` boolean: Enable the capability to force your own video to be featured for other participants
      - `sign` boolean: If the user have the capability enabled, this flag allow to create a new sign process. Visit digital signature section for more information. (always active in reception).
      - `whiteboard` object: if true enable all the whiteboard tools. Can be an object of whiteboard tools
        - `wb_pen` boolean: Allows to using the pen on the whiteboard
        - `wb_eraser` boolean: Allows to erase a previous draw on the whiteboard
        - `wb_add_file` boolean: Allows to add files on the whiteboard
        - `wb_text` boolean: Allows to add text on the whiteboard
        - `wb_shape` boolean: Allows to add shape on the whiteboard
        - `wb_cursor` boolean: Allows to send the cursor events to the other participants

## Other responses

- `401`: Unauthorized
- `404`: Room not found
- `429`: Too Many request

---

[API](https://skmtc.dev/kaleyra/apis/kaleyra-video-rest-api-v2.md) - [All operations](https://skmtc.dev/kaleyra/apis/kaleyra-video-rest-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/kaleyra/apis/kaleyra-video-rest-api-v2/revisions/4424fd54ae42?raw)
