Skip to main content
GET
GET /api/v1/social/{socialId}/attendees
Retrieves the list of all participants currently in a Scootaverse session.

Authorizations

X-API-Key
string
header
required

Path Parameters

socialId
string<uuid>
required

Query Parameters

isPresent
boolean
page
integer
default:0

Page number to get, used with pageSize

size
integer
default:20

Number of items to get in one request, used with page

sort
string

Property to sort by. Append ',' and directions 'asc/desc' to change direction

Response

200 - application/json

OK

socialAttendeeId
string<uuid>
socialId
string<uuid>
attendeeUserId
string<uuid>
attendeeUser
object
dateTimeArrived
string<date-time>
isHost
boolean
isPresent
boolean
location
string
ringColor
string
tokenId
string
streamConnectionId
string
status
enum<string>
Available options:
JOINED,
LEFT,
REJOINED,
NOT_STARTED,
ENDED,
QUEUED,
NOT_ADMITTED,
BANNED
queuePosition
integer
queueLength
integer
presenterVideoQuality
string
socialChanged
boolean
updatedWebsocketURL
string
favoriteUserIds
string<uuid>[]