---
title: "POST /ListParticipants"
method: POST
path: "/ListParticipants"
---

# POST /ListParticipants

`POST /ListParticipants`

Lists all participants in a specified stage session.

## Request body

- object
  - `stageArn` string, required — Stage ARN.
  - `sessionId` string, required — ID of the session within the stage.
  - `filterByUserId` string — Filters the response list to match the specified user ID. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request. A <code>userId</code> is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.
  - `filterByPublished` boolean — Filters the response list to only show participants who published during the stage session. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.
  - `filterByState` 'CONNECTED' | 'DISCONNECTED' — Filters the response list to only show participants in the specified state. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.
  - `nextToken` string — The first participant to retrieve. This is used for pagination; see the <code>nextToken</code> response field.
  - `maxResults` integer — Maximum number of results to return. Default: 50.
  - `filterByRecordingState` 'STARTING' | 'ACTIVE' | 'STOPPING' | 'STOPPED' | 'FAILED' — Filters the response list to only show participants with the specified recording state. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.

## Response `200`

Success

- ListParticipantsResponse
  - `participants` ParticipantSummary[], required — List of the matching participants (summary information only).
    - `participantId` string — Unique identifier for this participant, assigned by IVS.
    - `userId` string — Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information</i>.
    - `state` 'CONNECTED' | 'DISCONNECTED' — Whether the participant is connected to or disconnected from the stage.
    - `firstJoinTime` string, date-time — ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
    - `published` boolean — Whether the participant ever published to the stage session.
    - `recordingState` 'STARTING' | 'ACTIVE' | 'STOPPING' | 'STOPPED' | 'FAILED' | 'DISABLED' — The participant’s recording state.
    - `replicationType` 'SOURCE' | 'REPLICA' | 'NONE' — Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: <code>NONE</code>.
    - `replicationState` 'ACTIVE' | 'STOPPED' — The participant's replication state.
    - `sourceStageArn` string — Source stage ARN from which this participant is replicated, if <code>replicationType</code> is <code>REPLICA</code>.
    - `sourceSessionId` string — ID of the session within the source stage, if <code>replicationType</code> is <code>REPLICA</code>.
    - `redundantIngest` boolean — Indicates whether redundant ingest is enabled for the participant.
    - `ingestConfigurationArn` string — The participant’s ingest configuration.
  - `nextToken` string — If there are more participants than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.

## Other responses

- `480` — ValidationException
- `481` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/ivs-realtime.md) · [All operations](https://skmtc.net/aws/apis/ivs-realtime/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/ivs-realtime/revisions/f8857274a50f/schema)