Skip to main content
GET
List Players

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id
string

Player ID(s) to filter by. Accepts comma-separated values (e.g. 1,2,3) or repeated parameters (e.g. id[]=1&id[]=2). IDs that don't exist are left out.

name
string

Name of the player to search for. To search for multiple players, separate names with commas (e.g. coello,tapia) or repeat the parameter (e.g. name[]=coello&name[]=tapia).

nationality
string | null

2 letters country-code of the player.

Required string length: 2
category
enum<string> | null

Category of the player. Either men or women.

Available options:
men,
women
birthplace
string | null

Name of the birthplace of the player.

side
enum<string> | null

Side of the player, either drive or backhand.

Available options:
drive,
backhand
updated_after
string<date-time> | null

Filter players updated after this datetime in ISO 8601 format.

updated_before
string<date-time> | null

Filter players updated before this datetime in ISO 8601 format.

sort_by
enum<string> | null

Name of the parameter to sort the tournaments by.

Available options:
name,
ranking,
points,
elo,
height,
birthdate,
updated_at
order_by
enum<string> | null

Order of the sorting, either asc or desc.

Available options:
asc,
desc
page
integer | null
default:1

Page number to return, starting at 1.

Required range: x >= 1
per_page
integer | null
default:15

Number of results per page, from 1 to 50. Larger values return 50.

Required range: x >= 1

Response

Paginated set of PlayerResource

data
PlayerResource · object[]
required
meta
object
required