Skip to content

List themes

GET/v2/themes

GET
/v2/themes
curl --request GET \
--url 'https://api.ligr.live/rest/v2/themes?access=owned' \
--header 'Authorization: Bearer <token>'

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

Lists themes. By default (access=owned) the list holds the themes your organization owns. The theme routes can change only these themes.

access=usable lists every theme your organization can use in theme profiles and control rooms: the themes it owns, the themes LIGR linked to it, and the public themes. Only external Rive and code themes are in this list. Inbuilt themes, the legacy themes built into LIGR, are not. A linked theme is in the list when it has an active version. access on each item tells how your organization gets the theme.

access
string
Allowed values: owned usable

owned (default) or usable. A staff theme key has no organization, so it can list only owned.

Ok

Media typeapplication/json
Array<object>

One theme in GET /v2/themes.

object
id
required

Entity identifier

integer format: int32
>= 1
name
required
string
sports
required

Sport keys the theme supports, for example football.

Array<string>
activeVersion
required

Theme version the overlays render. Null means no version is active.

integer format: int32
nullable
access
required

How your organization gets the theme. owned: your organization owns it, and the theme routes can change it. linked: LIGR linked it to your organization. public: every organization can use it. Theme profiles and control rooms accept all three. The theme routes answer 404 for a linked or public theme.

string
Allowed values: owned linked public
createdAt
required

ISO 8601 timestamp.

string
Example
[
{
"access": "owned"
}
]

Request is invalid

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

Missing or invalid api key

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

Api key provides insufficient access for the request

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

Theme not found

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

Organization has made too many requests

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

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

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