---
title: "List ongoing matches"
method: GET
path: "/v2/console/match"
tags: ["Console"]
---

# List ongoing matches

`GET /v2/console/match`

## Request

- Base URL: `http://127.0.0.1:7351`
- URL: `http://127.0.0.1:7351/v2/console/match`
- Auth: API key in header `Authorization`

## Query parameters

- `limit` integer
- `authoritative` boolean
- `label` string
- `min_size` integer
- `max_size` integer
- `match_id` string
- `query` string
- `node` string

## Response `200`

A successful response.

- ConsoleMatchList: A list of realtime matches, with their node names.
  - `matches` MatchListMatch[]
    - `api_match` ApiMatch: Represents a realtime match.
      - `match_id` string: The ID of the match, can be used to join.
      - `authoritative` boolean: True if it's an server-managed authoritative match, false otherwise.
      - `label` string: Match label, if any.
      - `size` integer: Current number of users in the match.
      - `tick_rate` integer
      - `handler_name` string
    - `node` string

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2.md) - [All operations](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2/revisions/fbde2e3c5ead?raw)