Skip to main content
GET
Roster

Authorizations

X-Api-Key
string
header
required

Path Parameters

id
integer
required

Numeric ID of the team to get team players for

Query Parameters

fields
enum<string>[]

Specify custom response with available response fields.


Fields included as default: player, jerseyNumber, playerRole, contractType, clubTeamPlayerStats, updatedAt

Available options:
player,
jerseyNumber,
playerRole,
contractType,
clubTeamPlayerStats,
updatedAt,
player.*,
clubTeamPlayerStats.*,
*
offset
integer
default:0

The number of items to skip before starting to collect the result set.

Required range: x >= 0
limit
integer
default:100

The number of items to return.

Required range: 0 <= x <= 1000
sort
enum<string>[]

Sort results by field name. Prefix with - for descending order (e.g., -name).

Available options:
player,
-player,
player.position,
-player.position,
player.nationality,
-player.nationality,
player.age,
-player.age,
player.dateOfBirth,
-player.dateOfBirth,
player.placeOfBirth,
-player.placeOfBirth,
player.weight,
-player.weight,
player.height,
-player.height,
player.youthTeam,
-player.youthTeam,
player.shoots,
-player.shoots,
player.catches,
-player.catches,
player.contract,
-player.contract,
player.capHit,
-player.capHit,
jerseyNumber,
-jerseyNumber,
playerRole,
-playerRole,
clubTeamPlayerStats.league,
-clubTeamPlayerStats.league,
updatedAt,
-updatedAt
season
string

Filter by season slug

playerRole
enum<string> | null

Filter by playerRole

Available options:
C,
A,
null
playerRole:hasContent
boolean

Filter by playerRole has content

updatedAt:min
string<date-time>

Filter by updatedAt greater or equal to in ISO-8601 format for date and time

Response

200 - application/json

Roster, paginated.

_meta
object
data
object[]