---
title: "List (and optionally filter) accounts."
method: GET
path: "/v2/console/account"
tags: ["Console"]
---

# List (and optionally filter) accounts.

`GET /v2/console/account`

## Request

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

## Query parameters

- `filter` string
- `tombstones` boolean
- `cursor` string

## Response `200`

A successful response.

- AccountList: A list of users.
  - `users` ApiUser[]: A list of users.
    - `id` string: The id of the user's account.
    - `username` string: The username of the user's account.
    - `display_name` string: The display name of the user.
    - `avatar_url` string: A URL for an avatar image.
    - `lang_tag` string: The language expected to be a tag which follows the BCP-47 spec.
    - `location` string: The location set by the user.
    - `timezone` string: The timezone set by the user.
    - `metadata` string: Additional information stored as a JSON object.
    - `facebook_id` string: The Facebook id in the user's account.
    - `google_id` string: The Google id in the user's account.
    - `gamecenter_id` string: The Apple Game Center in of the user's account.
    - `steam_id` string: The Steam id in the user's account.
    - `online` boolean: Indicates whether the user is currently online.
    - `edge_count` integer: Number of related edges to this user.
    - `create_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user was created.
    - `update_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user was last updated.
    - `facebook_instant_game_id` string: The Facebook Instant Game ID in the user's account.
    - `apple_id` string: The Apple Sign In ID in the user's account.
  - `total_count` integer: Approximate total number of users.
  - `next_cursor` string: Next cursor.

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