# Heroic Labs Console API

**Canonical:** https://apis.io/apis/heroiclabs/heroiclabs-console-api/  
**Provider:** Heroic Labs — https://apis.io/providers/heroiclabs/  
**Base URL:** https://127.0.0.1:7350  
**Documentation:** https://heroiclabs.com/nakama/

Heroic Labs Console API is one of 4 APIs that [Heroic Labs](https://apis.io/providers/heroiclabs/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Console. The published artifact set on APIs.io includes an OpenAPI specification and a GitHub repository.

The Console API from Heroic Labs — 73 operation(s) for console.

## Operations (60 of 92)

| Method | Path | Summary |
|---|---|---|
| GET | `/v2/console/account` | List (and optionally filter) accounts. |
| DELETE | `/v2/console/account` | Delete (non-recorded) all user accounts. |
| POST | `/v2/console/account` | Import given account export data, creating a new account that fully matches the data. |
| GET | `/v2/console/account/{account_id}/note` | — |
| POST | `/v2/console/account/{account_id}/note` | — |
| DELETE | `/v2/console/account/{account_id}/note/{note_id}` | — |
| GET | `/v2/console/account/{account_id}/wallet` | Get a list of the user's wallet transactions. |
| GET | `/v2/console/account/{id}` | Get detailed account information for a single user. |
| DELETE | `/v2/console/account/{id}` | Delete all information stored for a user account. |
| POST | `/v2/console/account/{id}` | Update one or more fields on a user account. |
| POST | `/v2/console/account/{id}/ban` | Ban a user. |
| GET | `/v2/console/account/{id}/export` | Export all information stored about a user account. |
| GET | `/v2/console/account/{id}/friend` | Get a user's list of friend relationships. |
| DELETE | `/v2/console/account/{id}/friend/{friend_id}` | Delete the friend relationship between two users. |
| GET | `/v2/console/account/{id}/group` | Get a list of groups the user is a member of. |
| DELETE | `/v2/console/account/{id}/group/{group_id}` | Remove a user from a group. |
| PUT | `/v2/console/account/{id}/import` | Import given account export data, overwriting the user account's current state. |
| POST | `/v2/console/account/{id}/unban` | Unban a user. |
| POST | `/v2/console/account/{id}/unlink/apple` | Unlink the Apple ID from a user account. |
| POST | `/v2/console/account/{id}/unlink/custom` | Unlink the custom ID from a user account. |
| POST | `/v2/console/account/{id}/unlink/device` | Unlink the device ID from a user account. |
| POST | `/v2/console/account/{id}/unlink/email` | Unlink the email from a user account. |
| POST | `/v2/console/account/{id}/unlink/facebook` | Unlink the Facebook ID from a user account. |
| POST | `/v2/console/account/{id}/unlink/facebookinstantgame` | Unlink the Facebook Instant Game ID from a user account. |
| POST | `/v2/console/account/{id}/unlink/gamecenter` | Unlink the Game Center ID from a user account. |
| POST | `/v2/console/account/{id}/unlink/google` | Unlink the Google ID from a user account. |
| POST | `/v2/console/account/{id}/unlink/steam` | Unlink the Steam ID from a user account. |
| DELETE | `/v2/console/account/{id}/wallet/{wallet_id}` | Delete a wallet ledger item. |
| GET | `/v2/console/acl/template` | — |
| POST | `/v2/console/acl/template` | — |
| DELETE | `/v2/console/acl/template/{id}` | — |
| PUT | `/v2/console/acl/template/{id}` | — |
| DELETE | `/v2/console/all` | Deletes all data |
| GET | `/v2/console/api/endpoints` | API Explorer - list all endpoints |
| POST | `/v2/console/api/endpoints/rpc/{method}` | API Explorer - call a custom RPC endpoint |
| POST | `/v2/console/api/endpoints/{method}` | API Explorer - call an endpoint |
| GET | `/v2/console/audit/log` | List audit log entries with the selected filter |
| GET | `/v2/console/audit/log/users` | List console usernames that can be used to filter the audit logs |
| POST | `/v2/console/authenticate` | Authenticate a console user with username and password. |
| POST | `/v2/console/authenticate/logout` | Log out a session and invalidate the session token. |
| POST | `/v2/console/authenticate/mfa` | Change an account's MFA using a code, usually delivered over email. |
| POST | `/v2/console/authenticate/password_change` | Change an account's password using a code, usually delivered over email. |
| GET | `/v2/console/channel` | List channel messages with the selected filter |
| GET | `/v2/console/config` | Get server config and configuration warnings. |
| GET | `/v2/console/extensions` | — |
| GET | `/v2/console/group` | List (and optionally filter) groups. |
| POST | `/v2/console/group/{group_id}/account/{id}/demote` | Demote a user from a group. |
| POST | `/v2/console/group/{group_id}/account/{id}/promote` | Promote a user from a group. |
| POST | `/v2/console/group/{group_id}/add` | Add/join members to a group. |
| GET | `/v2/console/group/{id}` | Get detailed group information. |
| DELETE | `/v2/console/group/{id}` | Remove a group. |
| POST | `/v2/console/group/{id}` | Update one or more fields on a group. |
| GET | `/v2/console/group/{id}/export` | Export all information stored about a group. |
| GET | `/v2/console/group/{id}/member` | Get a list of members of the group. |
| GET | `/v2/console/iap/purchase/{transaction_id}` | Get purchase by transaction_id |
| GET | `/v2/console/iap/subscription/{original_transaction_id}` | Get subscription by original_transaction_id |
| GET | `/v2/console/leaderboard` | List leaderboards |
| GET | `/v2/console/leaderboard/{id}` | Get leaderboard. |
| DELETE | `/v2/console/leaderboard/{id}` | Delete leaderboard |
| DELETE | `/v2/console/leaderboard/{id}/owner/{owner_id}` | Delete leaderboard record |

…and 32 more operations. They are listed in full on the page.

## Machine-readable artifacts (2)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/heroiclabs/refs/heads/main/openapi/heroiclabs-console-api-openapi.yml
- **GitHubRepository** — https://github.com/heroiclabs/hiro

## Other Heroic Labs APIs (3)

- [Nakama API](https://apis.io/apis/heroiclabs/nakama-api/)
- [Satori API](https://apis.io/apis/heroiclabs/satori-api/)
- [Heroic Labs Rpc API](https://apis.io/apis/heroiclabs/heroiclabs-rpc-api/)

## Tags

Console

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/heroiclabs/heroiclabs-console-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/heroiclabs/.