---
title: "Get a list of participants for a room"
method: GET
path: "/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/participants"
tags: ["room"]
---

# Get a list of participants for a room

`GET /ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/participants`

## Path parameters

- `apiVersion` 'v4', required
- `token` string, required

## Query parameters

- `includeStatus` boolean

## Headers

- `x-nextcloud-federation` string
- `OCS-APIRequest` boolean, required

## Response `200`

Participants returned

- object
  - `ocs` object, required
    - `meta` OCSMeta, required
      - `status` string, required
      - `statuscode` integer, required
      - `message` string
      - `totalitems` string
      - `itemsperpage` string
    - `data` Participant[], required
      - `actorId` string, required — The unique identifier for the given actor type
      - `invitedActorId` string — The cloud id of the invited user
      - `actorType` string, required — Currently known `users|guests|emails|groups|circles` (see [Constants - Attendee types](https://nextcloud-talk.readthedocs.io/en/latest/constants#attendee-types))
      - `attendeeId` integer, required — Unique attendee id
      - `attendeePermissions` integer, required — Dedicated permissions for the current participant, if not `Custom` this are not the resulting permissions (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#attendee-permissions))
      - `attendeePin` string, required — Unique dial-in authentication code for this user, when the conversation has SIP enabled (see `sipEnabled` attribute)
      - `displayName` string, required — Can be empty for guests
      - `inCall` integer, required — Call flags the user joined with (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#participant-in-call-flag))
      - `lastPing` integer, required — Timestamp of the last ping of the user (should be used for sorting)
      - `participantType` integer, required — Permissions level of the participant (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#participant-types))
      - `permissions` integer, required — Combined final permissions for the participant, permissions are picked in order of attendee then call then default and the first which is `Custom` will apply (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#attendee-permissions))
      - `roomToken` string, required — Only available with `breakout-rooms-v1` capability
      - `sessionIds` string[], required — Array of session ids, each are up to 512 character long strings, or empty if no session
      - `status` string — Only available with `includeStatus=true`, for users with a set status and when there are less than 100 participants in the conversation
      - `statusClearAt` integer, nullable — Only available with `includeStatus=true`, for users with a set status and when there are less than 100 participants in the conversation
      - `statusIcon` string, nullable — Only available with `includeStatus=true`, for users with a set status and when there are less than 100 participants in the conversation
      - `statusMessage` string, nullable — Only available with `includeStatus=true`, for users with a set status and when there are less than 100 participants in the conversation
      - `phoneNumber` string, nullable — Only available with `sip-support-dialout` capability and only filled for moderators that are allowed to configure SIP for conversations
      - `callId` string, nullable — Only available with `sip-support-dialout` capability and only filled for moderators that are allowed to configure SIP for conversations

## Other responses

- `403` — Missing permissions for getting participants

---

[API](https://skmtc.dev/nextcloud/apis/spreed-full.md) · [All operations](https://skmtc.dev/nextcloud/apis/spreed-full/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nextcloud/spreed-full/revisions/41d6458d6d6e/schema)