Skip to content
The API may change between versions while TTX-Zone is 0.x.

Get rooms

GET
/api/v1/ttx/{ttx_id}/rooms

The exercise’s rooms and who sits in each.

Successful Response

Media typeapplication/json
RoomsRead

Creator -> Exercise -> Rooms: whether the exercise uses rooms, its rooms and its Players with their seat.

object
players
required
Players
Array<object>
RoomPlayerRead
object
email
required
Email
string
full_name
required
Full Name
string
joined_at
required
Joined At
string format: date-time
last_login_at
Any of:
string format: date-time
room_id
Any of:
string format: uuid
user_id
required
User Id
string format: uuid
rooms
required
Rooms
Array<object>
RoomRead
object
code
required
Code
string
description
required
Description
string
id
required
Id
string format: uuid
name
required
Name
string
player_count
required
Player Count
integer
structure_locked
required
Structure Locked
boolean
team
Team
Array<object>
default:
RoomTeamMemberRead

A team member who follows the session, and the room their view of it opens on (null: the main room). They can still look at any room.

object
email
required
Email
string
full_name
required
Full Name
string
roles
required
Roles
Array<string>
room_id
Any of:
string format: uuid
user_id
required
User Id
string format: uuid
uses_rooms
required
Uses Rooms
boolean

Example

{
"team": []
}