Skip to main content

Get the room config

Get the room config

Path Parameters
slug string REQUIRED

The slug of the room

Responses
200

Successful response

Schema OPTIONAL
metadata object
slug string
name string
description
iconURL
canvasDimensions number
isPublic boolean
studentsWhitelist number[] OPTIONAL
studentsBlacklist number[] OPTIONAL
ownerUid number
createdAt date-time
settings object
roomColors string
rateLimits object
testsLimiter object
limit number
interval number
getCanvasLimiter object
limit number
interval number
getPixelLimiter object
limit number
interval number
placePixelLimiter object
limit number
interval number
getRoomsLimiter object
limit number
interval number
getRoomConfigLimiter object
limit number
interval number
createRoomLimiter object
limit number
interval number
updateRoomLimiter object
limit number
interval number
deleteRoomLimiter object
limit number
interval number
getStudentLimiter object
limit number
interval number
updateStudentLimiter object
limit number
interval number
sendMessageLimiter object
limit number
interval number
reportRoomLimiter object
limit number
interval number
401

Unauthorized

Schema OPTIONAL
code string OPTIONAL
message string OPTIONAL
403

Forbidden

Schema OPTIONAL
code string OPTIONAL
message string OPTIONAL
429

Too Many Requests

Schema OPTIONAL
code string OPTIONAL
message string OPTIONAL
500

Internal Server Error

Schema OPTIONAL
code string OPTIONAL
message string OPTIONAL