Skip to content
Developers

List theme variables

GET/v2/themes/{themeId}/variables

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

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

Lists the variables of a theme your organization owns. An operator sets each value per competition, and the graphics read the value while they render.

The response carries the theme’s updatedAt. Send it back as ifUnchangedSince on the next add, set or rm, so that write answers 409 TARGET_CHANGED if the theme moved.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
themeId
required
number format: double

The theme identifier

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json

Body of GET /v2/themes/{themeId}/variables.

updatedAt is the theme’s updatedAt at the time of this read. Send it back as ifUnchangedSince on the next write to var add, set or rm this variable list.

object
updatedAt
required
string
variables
required
Array<object>

One theme variable. An operator sets the value per competition; the graphics read it.

object
id
required

Equal to name for a variable this API created.

string
name
required
string
type
required
string
Allowed values: string number boolean enum
defaultValue
required

The value in force when a competition sets nothing. Null means no default.

string
nullable
description
required
string
nullable
enumOptions
required

Allowed values of an enum variable. Null for the other types.

Array<string>
nullable
isStyle
required

True when the variable holds a colour, a font or another style value.

boolean
Example
{
  "variables": [
    {
      "type": "string"
    }
  ]
}

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