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

# POST /GetParticipant

`POST /GetParticipant`

Gets information about the specified participant token.

## Request body

- object
  - `stageArn` string, required — Stage ARN.
  - `sessionId` string, required — ID of a session within the stage.
  - `participantId` string, required — Unique identifier for the participant. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.

## Response `200`

Success

- GetParticipantResponse
  - `participant` object — The participant that is returned.
    - `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.
    - `attributes` object — Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information</i>.
    - `published` boolean — Whether the participant ever published to the stage session.
    - `ispName` string — The participant’s Internet Service Provider.
    - `osName` string — The participant’s operating system.
    - `osVersion` string — The participant’s operating system version.
    - `browserName` string — The participant’s browser.
    - `browserVersion` string — The participant’s browser version.
    - `sdkVersion` string — The participant’s SDK version.
    - `recordingS3BucketName` string — Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or <code>""</code> (empty string), if recording is not enabled.
    - `recordingS3Prefix` string — S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or <code>""</code> (empty string), if recording is not enabled. If individual participant recording merge is enabled, and if a stage publisher disconnects from a stage and then reconnects, IVS tries to record to the same S3 prefix as the previous session. See <a href="/ivs/latest/RealTimeUserGuide/rt-individual-participant-recording.html#ind-part-rec-merge-frag"> Merge Fragmented Individual Participant Recordings</a>.
    - `recordingState` 'STARTING' | 'ACTIVE' | 'STOPPING' | 'STOPPED' | 'FAILED' | 'DISABLED' — The participant’s recording state.
    - `protocol` 'UNKNOWN' | 'WHIP' | 'RTMP' | 'RTMPS' — Type of ingest protocol that the participant employs for broadcasting.
    - `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.

## Other responses

- `480` — ResourceNotFoundException
- `481` — ValidationException
- `482` — 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/versions/f8857274a50f/schema)