---
title: "Get current state of a running match"
method: GET
path: "/v2/console/match/{id}/state"
tags: ["Console"]
---

# Get current state of a running match

`GET /v2/console/match/{id}/state`

## Request

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

## Path parameters

- `id` string, required

## Response `200`

A successful response.

- MatchState
  - `presences` UserPresence[]: Presence list.
    - `user_id` string: The user this presence belongs to.
    - `session_id` string: A unique session ID identifying the particular connection, because the user may have many.
    - `username` string: The username for display purposes.
    - `persistence` boolean: Whether this presence generates persistent data/messages, if applicable for the stream type.
    - `status` string: A user-set status message for this stream, if applicable.
  - `tick` string, int64: Current tick number.
  - `state` string: State.

## 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)