Roster

Get Roster

Changed on

List roster assignments, optionally scoped by competition.

get/api/v1/roster

Request

  • Base URL
    https://developer.preciser.io
  • URL
    https://developer.preciser.io/api/v1/roster
  • Auth
    none declared. Required headers: x-api-key, League

Query parameters

seasonstring nullable
competition_idstring nullable
team_idstring nullable
player_idstring nullable
limitinteger
offsetinteger

Headers

x-api-keystring required

Required API key issued by Preciser.

Leaguestring required

Required tenant/database selector, for example pitchbio-master.

Response

Successful Response

limitinteger required
offsetinteger required
countinteger required
totalinteger required

Changes

  • 9b0abde08b06Revision changes
    • breaking

      the header request parameter League became required

    • breaking

      the header request parameter x-api-key became required

    • breaking

      header request parameter League list-of-types was narrowed by removing types null

    • breaking

      header request parameter x-api-key list-of-types was narrowed by removing types null

    • info

      for the header request parameter League, the type was generalized from no type to string

    • info

      for the header request parameter x-api-key, the type was generalized from no type to string

  • 64853d21435bRevision changes
    • info

      endpoint added