HIhify
Admin Tournament Matches

List every match of a tournament for content operations

Admin only. Returns all of the tournament's matches, completed included, ordered by game start time, court and sequence number, and paged on every request (X-Total-Count / X-Total-Pages). The scorer app's list at /v1/tournaments/{id}/matches is a different view: it hides completed matches and scopes claims to the caller.

get/v1/admin/tournaments/{tournament_id}/matches

Request

  • Base URL
    https://api.hify.club
  • Auth
    API key in header X-User-Token

Query parameters

datestring date

YYYY-MM-DD. Matches whose game starts on that calendar day at the venue (the facility's country time zone), not in UTC.

arena_idinteger

Only matches played on this arena.

status'pending' | 'in_progress' | 'completed'

An unknown value is a 422, not an empty list.

searchstring

Case-insensitive substring of a player's first or last name, an anonymous participant's name (feed name or linked account), or a side's team name.

pageinteger

Page number (1-based).

per_pageinteger

Items per page, default 25.

Response

Matches

idinteger
external_idstring nullable

The partner's match id when the match came from a feed.

game_idinteger
sequence_numberinteger nullable
round_numberinteger nullable
stage'league' | 'quarterfinal' | 'semifinal' | 'knockout' | 'final' | 'third_place'
categorystring nullable

Display label, e.g. "Open Mixed Doubles".

status'pending' | 'in_progress' | 'completed'
winner_side'side_a' | 'side_b' | 'draw' nullable
completion_reasonstring nullable
scoring_format_idinteger nullable
court_numberinteger nullable

The arena's in_facility_id.

started_atstring date-time nullable

scored_at of the match's first non-voided score entry, the same value the scorer app's Match.started_at carries. Null until the match has been scored. The game's start_time is the slot; this is the match.

ended_atstring date-time nullable

scored_at of the match's last non-voided score entry. Null until the match has been scored.

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.