List theme profiles

GET

/v2/competitions/{competitionId}/theme-profiles

curl --request GET \
  --url https://api.ligr.live/rest/v2/competitions/1/theme-profiles \
  --header 'Authorization: Bearer <token>'

• LIGR REST API

Lists active profiles that use themes your organization owns. The competition must belong to your organization. Archived profiles are excluded.

Authorizations

• bearer
  competitions:read
• api_key
  competitions:read

Parameters

Path Parameters

competitionId

required

Entity identifier

integer format: int32

>= 1

Responses

200

Ok

Media typeapplication/json

Array<object>

object

id

required

Entity identifier

integer format: int32

>= 1

competitionId

required

Entity identifier

integer format: int32

>= 1

themeId

required

Entity identifier

integer format: int32

>= 1

name

required

string

defaultControlRoomId

required

integer format: int32

>= 1

isDefault

required

boolean

themeVariableValues

required

Array<object>

object

variableId

required

Variable id from the theme schema.

string

value

required

Any of:

string

string

number

number format: double

boolean

boolean

Example^generated

[
  {
    "id": 1,
    "competitionId": 1,
    "themeId": 1,
    "name": "example",
    "defaultControlRoomId": 1,
    "isDefault": true,
    "themeVariableValues": [
      {
        "variableId": "example",
        "value": "example"
      }
    ]
  }
]

400

Request is invalid

Media typeapplication/json

object

message

required

string

details

required

object

key

additional properties

Example^generated

{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Missing or invalid api key

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Api key provides insufficient access for the request

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

404

Competition, theme, control room, or profile not found

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

429

Api key has made too many requests

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

500

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

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}