Match Discovery

List an organization's matches

Changed on

Returns matches across all teams in an organization (resolved by id or slug), newest first, with cursor pagination. The authenticated user must be an active member of the organization. Requires the matches.org_matches:read permission.

post/orgs/{identifier}/matches

Request

  • Base URL
    https://teambattles.gg/api/v1
  • URL
    https://teambattles.gg/api/v1/orgs/{identifier}/matches
  • Auth
    HTTP bearer

Path parameters

identifierstring required

Organization id or slug.

Request body

numItemsinteger

Page size (1-100). Defaults to 25.

cursorstring nullable

Opaque continuation cursor from a prior page's continueCursor.

includeStatusesstring[]

Only include matches with these MatchStatus codes; unknown values are ignored.

excludeStatusesstring[]

Exclude matches with these MatchStatus codes; unknown values are ignored.

gameIdstring

Filter to a single game by id.

scheduledAfterstring

ISO 8601; only matches scheduled at or after this time.

scheduledBeforestring

ISO 8601; only matches scheduled at or before this time.

createdAfterstring

ISO 8601; only matches created at or after this time.

createdBeforestring

ISO 8601; only matches created at or before this time.

opponentIdstring

Filter to matches against this opponent team (team id or slug).

Response

Cursor-paginated result. continueCursor is non-null even when isDone is true.

isDoneboolean required
continueCursorstring required

Changes

  • 82f2480cdb83Revision changes
    • info

      api tag Match Discovery added

    • info

      api tag Matches removed

  • 480c7d480b2eRevision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status