Skip to content
Developers

List team players

GET/v1/teams/{teamId}/players

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

Return the players on a team.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
teamId
required

Entity identifier

integer format: int32
>= 1

The team id

Responses

Section titled “Responses”

200

Section titled “200”

Ok

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

Entity identifier

integer format: int32
>= 1
firstName
required

Default Player first name

string
>= 1 characters <= 35 characters
gfxFirstName
required

Name predominantly display in graphics

string
nullable >= 1 characters <= 19 characters
gfxLastName
required

Name predominantly display in graphics

string
nullable >= 1 characters <= 19 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
starter
required
boolean
bench
required
boolean
captain
required
boolean
photoUrl
string
nullable /https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/
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”

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