Skip to content

Get a theme

GET/v2/themes/{themeId}

GET
/v2/themes/{themeId}
curl --request GET \
--url https://api.ligr.live/rest/v2/themes/1 \
--header 'Authorization: Bearer <token>'

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

Returns one theme and its published versions. The response also lists every graphic in the theme with the published versions of that graphic.

The theme must belong to your organization. A linked or public theme answers 404, because the response holds editing data: working versions, unpublished graphics and editor settings.

themeId
required

Entity identifier

integer format: int32
>= 1

The theme identifier

Ok

Media typeapplication/json
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
versions
required

Published theme version numbers, in ascending order.

Array<integer>
graphics
required
Array<object>
object
graphicId
required

Stable graphic identifier. It does not change between versions.

string
name
required
string
type
required

code or rive.

string
workingVersion
required

Version number of the editable working copy.

integer format: int32
publishedVersions
required

Published version numbers, in ascending order.

Array<integer>
requireRiveSource
required

True when every Rive import must carry editable source (.rev or project ZIP).

boolean
rendererRelease
required

A Rive renderer release choice of a theme, or of one graphic. A graphic without one follows its theme.

object
policy
required
string
Allowed values: latest pinned
release

The release for pinned, for example 2.41.0-r1.

string
public
required

True when every organization can use the theme. Only LIGR staff change it, in the dashboard.

boolean
Example
{
"rendererRelease": {
"policy": "latest"
}
}

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"
}