Skip to main content
GET
/
api
/
v1
/
social
/
saved
GET /api/v1/social/saved
curl --request GET \
  --url https://api.scoot.app/api/v1/social/saved
[
  {
    "socialId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "socialRoomSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "socialURI": "<string>",
    "sessionId": "<string>",
    "isOpen": true,
    "recurring": true,
    "anyoneCanStart": true,
    "isValid": true,
    "free": true,
    "allowGuestUsers": true,
    "user": {
      "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
    },
    "socialPermissionType": "PUBLIC",
    "platform": "SCOOT",
    "maxParticipants": 123,
    "startingWidth": 123,
    "startingHeight": 123,
    "hostAdmitted": true,
    "themeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "configurationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "theme": {
      "socialThemeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "LAYERED",
      "socialThemeName": "<string>",
      "description": "<string>",
      "colorPrimary": "<string>",
      "colorSecondary": "<string>",
      "colorBackground": "<string>",
      "colorGradientBackground": "<string>",
      "colorButtonText": "<string>",
      "colorButtonBG": "<string>",
      "imageFarURI": "<string>",
      "imageMidURI": "<string>",
      "imageNearURI": "<string>",
      "previewImageURI": "<string>",
      "minimapImageURI": "<string>",
      "imageWidth": 123,
      "imageHeight": 123,
      "templateId": "<string>",
      "defaultArtifactSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "multiSize": true,
      "addToMiniMap": true,
      "tiles": [
        {
          "uri": "<string>",
          "x": 123,
          "y": 123,
          "width": 123,
          "height": 123
        }
      ],
      "uploadStatus": {
        "requestStatusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "requestId": "<string>",
        "status": "IN_PROGRESS",
        "progress": 123,
        "failureReason": "<string>",
        "startedDateTime": "2023-11-07T05:31:56Z",
        "endedDateTime": "2023-11-07T05:31:56Z"
      }
    },
    "playlistId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "artifactSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startDateTime": "2023-11-07T05:31:56Z",
    "endDateTime": "2023-11-07T05:31:56Z",
    "dateCreated": "2023-11-07T05:31:56Z",
    "companyName": "<string>",
    "socialMeta": {
      "socialMetaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "numberOfInvites": 123,
      "numberOfAttendees": 123,
      "numberCurrentlyPresent": 123,
      "audioHost": "<string>",
      "audioElementURL": "<string>",
      "peerConnectionURL": "<string>"
    },
    "connectedRoom": true,
    "updatedByUser": {
      "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
    },
    "updatedDateTime": "2023-11-07T05:31:56Z",
    "alternateHosts": [
      {
        "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
      }
    ],
    "myBadgeData": [
      {
        "title": "<string>",
        "value": "<string>",
        "multiValues": [
          "<string>"
        ],
        "options": [
          "<string>"
        ],
        "description": "<string>",
        "required": true,
        "featured": true,
        "visibility": "ALL",
        "inputType": "TEXT"
      }
    ]
  }
]
Retrieves all Scootaverses that the current user has saved for quick access.

Query Parameters

includeOpen
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

socialId
string<uuid>
socialRoomSetId
string<uuid>
userId
string<uuid>
companyId
string<uuid>
name
string
description
string
socialURI
string
sessionId
string
isOpen
boolean
recurring
boolean
anyoneCanStart
boolean
isValid
boolean
free
boolean
allowGuestUsers
boolean
user
object
socialPermissionType
enum<string>
Available options:
PUBLIC,
COMPANY_AND_CONNECTIONS,
CONNECTIONS,
COMPANY
platform
enum<string>
Available options:
SCOOT,
PRECIATE
maxParticipants
integer
startingWidth
integer
startingHeight
integer
hostAdmitted
boolean
themeId
string<uuid>
configurationId
string<uuid>
theme
object
playlistId
string<uuid>
artifactSetId
string<uuid>
startDateTime
string<date-time>
endDateTime
string<date-time>
dateCreated
string<date-time>
companyName
string
socialMeta
object
connectedRoom
boolean
updatedByUser
object
updatedDateTime
string<date-time>
alternateHosts
object[]
myBadgeData
object[]
I