Skip to content
Developers

Get a match lineup

GET/v1/matches/{matchId}/lineup

GET
/v1/matches/{matchId}/lineup
curl --request GET \
  --url https://api.ligr.live/rest/v1/matches/1/lineup \
  --header 'Authorization: Bearer <token>'

Return the player lineup for a match.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
matchId
required

Entity identifier

integer format: int32
>= 1

The match id

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json
object
lineup
required
Array<object>
object
id
required

Entity identifier

integer format: int32
>= 1
teamId
required

Entity identifier

integer format: int32
>= 1
firstName
required

Default Player first name

string
>= 1 characters <= 35 characters
lastName
required

Default Player first name

string
>= 1 characters <= 35 characters
position
required
string
nullable
positionType
required
string
nullable
number
required
string
0 <= 3 characters
photoUrl
string
nullable /https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/
captain
required
boolean
starter
required
boolean
formationNumber
required

The player’s slot in the team’s formation layout, numbered from the goalkeeper through to the forwards. Null when no formation slot is assigned.

number format: double
nullable
lineupPosition
required

The player’s position in the team’s lineup ordering as managed in the control room. Null when no explicit lineup order is set.

number format: double
nullable
count
required
integer format: int32
Example
{
  "count": 24
}

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”

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