Skip to content
Developers

List control rooms

GET/v2/control-rooms

GET
/v2/control-rooms
curl --request GET \
  --url https://api.ligr.live/rest/v2/control-rooms \
  --header 'Authorization: Bearer <token>'

Beta. This operation can change between minor versions. See Beta status.

Returns rooms owned by your organization. Use themeId to filter rooms for an owned theme.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
themeId

Entity identifier

integer format: int32
>= 1

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json
Array<object>
object
id
required

Entity identifier

integer format: int32
>= 1
themeId
required

Entity identifier

integer format: int32
>= 1
name
required
string
sections
required
Array<object>
object
id
required
string
name
required
string
colorKey
string
Examplegenerated
[
  {
    "id": 1,
    "themeId": 1,
    "name": "example",
    "sections": [
      {
        "id": "example",
        "name": "example",
        "colorKey": "example"
      }
    ]
  }
]

400

Section titled “400”

Request is invalid

Media typeapplication/json
object
message
required
string
details
required
object
key
additional properties
Examplegenerated
{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Missing or invalid api key

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

403

Section titled “403”

Api key provides insufficient access for the request

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

404

Section titled “404”

Theme, control room, section, or graphic not found

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

429

Section titled “429”

Api key has made too many requests

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

500

Section titled “500”

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}