List all players with pagination and search

GET

/api/v1/players

const url = 'https://internal.myscore.live/api/v1/api/v1/players?page=1&perPage=20&sortBy=createdAt&sortOrder=asc&search=Nadal&includeGhosts=true';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://internal.myscore.live/api/v1/api/v1/players?page=1&perPage=20&sortBy=createdAt&sortOrder=asc&search=Nadal&includeGhosts=true'

Returns a paginated list of players. Supports search by name.

Parameters

Query Parameters

page

number

default: 1 >= 1

Example

Page number (1-indexed)

perPage

number

default: 20 >= 1 <= 100

Example

Number of items per page

sortBy

string

Example

createdAt

Field to sort by

sortOrder

string

default: desc

Allowed values: asc desc

Example

desc

Sort order

search

string

Example

Nadal

Search by player name

includeGhosts

string

Example

true

Include ghost players (userId=null)

Responses

200

List of players

application/json

object

data

required

Page of players

Array<object>

object

required

Unique player identifier

string

name

required

Player full name

string

nationality

ISO 3166-1 alpha-2 country code

string

nullable

gender

Player gender

string

nullable

Allowed values: male female

profileImageUrl

required

Profile image URL

string

clubs

required

Active club memberships (leftAt IS NULL). Empty array when none.

Array<object>

object

required

Club ID

string

name

required

Club display name

string

role

required

Member’s role within the club

string

Allowed values: member admin

isPrimary

required

Whether this is the player’s primary (Stammverein) club. At most one active membership per player is primary.

boolean

createdAt

required

Record creation timestamp

string format: date-time

updatedAt

required

Record last update timestamp

string format: date-time

meta

required

Pagination metadata

object

total

required

Total number of items

number

page

required

Current page number (1-indexed)

number

>= 1

perPage

required

Number of items per page

number

>= 1

totalPages

required

Total number of pages

number

>= 1

hasNextPage

required

Whether there is a next page

boolean

hasPreviousPage

required

Whether there is a previous page

boolean

Example

{
  "data": [
    {
      "id": "plr_abc123",
      "name": "Rafael Nadal",
      "nationality": "ES",
      "gender": "male",
      "profileImageUrl": "/api/v1/players/plr_abc123/image",
      "clubs": [
        {
          "id": "clb_abc123",
          "name": "TC Musterstadt Süd",
          "role": "member",
          "isPrimary": true
        }
      ],
      "createdAt": "2024-08-15T10:30:00.000Z",
      "updatedAt": "2024-09-01T14:20:00.000Z"
    }
  ],
  "meta": {
    "total": 100,
    "page": 1,
    "perPage": 20,
    "totalPages": 5,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

429

Rate limit exceeded