Live Platform API v1
Live Platform API
Live Platform API
Version 1

Retrieve participants

Copy link

Retrieves all participants in a live event.


HTTP request

Copy link
GET https://api-{application_id}.calls.sendbird.com/v1/live-events/{live_event_id}/participants

Parameters

Copy link

The following table lists the parameters that this action supports.

Parameters
OptionalTypeDescription

limit

int

Specifies the number of results to retrieve per page. Acceptable values are 1 to 100, inclusive. (Default: 10)

prev

string

Specifies the value of the prev property in the response to retrieve the previous page in the result set.

next

string

Specifies the value of the next property in the response to retrieve the next page in the result set.


Response

Copy link

If successful, this action returns all participants in the specified live event.

{
    "participants": [
        {
            "client_id": "test-client-id",
            "duration": 0,
            "entered_at": 1657692983239,
            "exited_at": none,
            "live_event_id": "1b06a54c-807b-4caa-8a25-3a97ee4fe691",
            "participant_id": "1e411c1d-af5e-49e8-ae20-a463f93be4d1",
            "state": "entered",
            "user": {
                "is_active": true,
                "metadata": {},
                "nickname": "",
                "profile_url": "",
                "role": none,
                "user_id": "vier-testuser-5652b67139e240c39c135604e54c9c02-1657692981",
            },
        },
        {
            "client_id": "test-client-id",
            "duration": 0,
            "entered_at": 1657692983171,
            "exited_at": none,
            "live_event_id": "1b06a54c-807b-4caa-8a25-3a97ee4fe691",
            "participant_id": "079518e1-8921-4831-b812-76d1b57c9de7",
            "state": "entered",
            "user": {
                "is_active": true,
                "metadata": {},
                "nickname": "",
                "profile_url": "",
                "role": none,
                "user_id": "vier-testuser-43103ce314a44f11a630df76f03e59c3-1657692981",
            },
        },
        ... # More participants
    ],
    "prev": "LWs1OQJJV1FeRxtSDwALfjQwZ2gCXgwHUElWQx1HQwNnazg",
    "next": none,
}

List of response properties

Copy link
Property nameTypeDescription

participants

nested object

The users who participated in the live event.

prev

string

Specifies the value of the prev property in the response to retrieve the previous page in the result set.

next

string

Specifies the value of the next property in the response to retrieve the next page in the result set.