Entry Config Details

GET /api/v1/rules/entry/config/details

GET /api/v1/rules/entry/config/details

cURL

curl --request GET \
  --url https://api.scoot.app/api/v1/rules/entry/config/details \
  --header 'X-API-Key: <api-key>'

200

{
  "configurationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "groupSpawnSize": 123,
  "groupFormerCount": 123,
  "startingPointX": 123,
  "startingPointY": 123,
  "rules": [
    {
      "property": "<string>",
      "operator": "<string>",
      "value": "<string>"
    }
  ],
  "associatedSocialIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Retrieves detailed configuration information for entry rules in Scootaverse sessions.

Authorizations

X-API-Key · string · header · required

Query Parameters

socialRoomSetId · string<uuid> · required

configurationId · string<uuid> · required

Response

200 - application/json

OK

configurationId · string<uuid>

name · string

entryOption · enum<string>

Available options: DEFAULT, ACCOUNT, CUSTOM_RULES, STARTING_POINT

groupSpawnSize · integer

groupFormerCount · integer

startingPointX · integer

startingPointY · integer

entryFlow · enum<string>

Available options: SPIRAL, GRID

rules · object[]

Show child attributes

associatedSocialIds · string<uuid>[]