Skip to content
Developers

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.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
themeId
required

Entity identifier

integer format: int32
>= 1

The theme identifier

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json
object
id
required

Entity identifier

integer format: int32
>= 1
name
required
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>
Examplegenerated
{
  "id": 1,
  "name": "example",
  "activeVersion": 1,
  "versions": [
    1
  ],
  "graphics": [
    {
      "graphicId": "example",
      "name": "example",
      "type": "example",
      "workingVersion": 1,
      "publishedVersions": [
        1
      ]
    }
  ]
}

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