Skip to main content
GET
List Pairs

Authorizations

Authorization
string
header
required

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

Query Parameters

id
string

Pair ID(s) to filter by, each one the two player IDs joined by a hyphen in ascending order. Accepts comma-separated values (e.g. 65-66,12-34) or repeated parameters (e.g. id[]=65-66&id[]=12-34). IDs that don't exist are left out.

category
enum<string> | null

Category of the pair, either men or women.

Available options:
men,
women
after_date
string<date> | null

Date after which the pair has played a match in YYYY-MM-DD format. Pairs without matches in the range are excluded.

before_date
string<date> | null

Date before which the pair has played a match in YYYY-MM-DD format.

sort_by
enum<string> | null

Name of the parameter to sort the pairs by. Defaults to last_match_at (date of their most recent match together, desc).

Available options:
last_match_at,
first_match_at
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 PairResource

data
PairResource · object[]
required
meta
object
required