Skip to main content
GET
/
api
/
v1
/
social
/
{socialId}
/
attendees
GET /api/v1/social/{socialId}/attendees
curl --request GET \
  --url https://api.scoot.app/api/v1/social/{socialId}/attendees \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.scoot.app/api/v1/social/{socialId}/attendees"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.scoot.app/api/v1/social/{socialId}/attendees', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scoot.app/api/v1/social/{socialId}/attendees",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.scoot.app/api/v1/social/{socialId}/attendees"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.scoot.app/api/v1/social/{socialId}/attendees")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.scoot.app/api/v1/social/{socialId}/attendees")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "socialAttendeeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "socialId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attendeeUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attendeeUser": {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "firstName": "<string>",
      "middleName": "<string>",
      "lastName": "<string>",
      "emailAddress": "<string>",
      "emailVerified": true,
      "preload": true,
      "mobilePhone": "<string>",
      "mobilePhoneVerified": true,
      "mobilePhoneVerifiedWeb": true,
      "profileId": "<string>",
      "profileImageURI": "<string>",
      "profileImageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "profileImageBackground": "<string>",
      "timeZone": "<string>",
      "registeredDateTime": "2023-11-07T05:31:56Z",
      "active": true,
      "actedAs": true
    },
    "dateTimeArrived": "2023-11-07T05:31:56Z",
    "isHost": true,
    "isPresent": true,
    "location": "<string>",
    "ringColor": "<string>",
    "tokenId": "<string>",
    "streamConnectionId": "<string>",
    "queuePosition": 123,
    "queueLength": 123,
    "presenterVideoQuality": "<string>",
    "socialChanged": true,
    "updatedWebsocketURL": "<string>",
    "favoriteUserIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
]
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>[]