--- title: "Export all information stored about a user account." method: GET path: "/v2/console/account/{id}/export" tags: ["Console"] --- # Export all information stored about a user account. `GET /v2/console/account/{id}/export` ## Request - Base URL: `http://127.0.0.1:7351` - URL: `http://127.0.0.1:7351/v2/console/account/{id}/export` - Auth: API key in header `Authorization` ## Path parameters - `id` string, required ## Response `200` A successful response. - AccountExport: An export of all information stored for a user account. - `account` ApiAccount: A user with additional account details. Always the current user. - `user` ApiUser: A user in the server. - `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. - `wallet` string: The user's wallet data. - `email` string: The email address of the user. - `devices` AccountDevice[]: The devices which belong to the user's account. - `id` string: A device identifier. Should be obtained by a platform-specific device API. - `vars` object: Extra information that will be bundled in the session token. - `custom_id` string: The custom id in the user's account. - `verify_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user's email was verified. - `disable_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user's account was disabled/banned. - `providers` AccountProviderIdentity[]: The authentication provider identities linked to the user's account. - `provider` string: The name the provider was registered under during runtime initialization. - `provider_user_id` string: The user's ID with that provider. - `objects` StorageObject[]: The user's storage. - `collection` string: The collection which stores the object. - `key` string: The key of the object within the collection. - `user_id` string: The user owner of the object. - `value` string: The value of the object. - `version` string: The version hash of the object. - `permission_read` integer: The read access permissions for the object. - `permission_write` integer: The write access permissions for the object. - `create_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was created. - `update_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was last updated. - `friends` Friend[]: The user's friends. - `user` ApiUser: A user in the server. - `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. - `state` integer: The friend status. one of "Friend.State". - `update_time` string, date-time: Time of the latest relationship update. - `metadata` string: Metadata. - `groups` Group[]: The user's groups. - `id` string: The id of a group. - `creator_id` string: The id of the user who created the group. - `name` string: The unique name of the group. - `description` string: A description for the group. - `lang_tag` string: The language expected to be a tag which follows the BCP-47 spec. - `metadata` string: Additional information stored as a JSON object. - `avatar_url` string: A URL for an avatar image. - `open` boolean: Anyone can join open groups, otherwise only admins can accept members. - `edge_count` integer: The current count of all members in the group. - `max_count` integer: The maximum number of members allowed. - `create_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was created. - `update_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was last updated. - `messages` ChannelMessage[]: The user's chat messages. - `channel_id` string: The channel this message belongs to. - `message_id` string: The unique ID of this message. - `code` integer: The code representing a message type or category. - `sender_id` string: Message sender, usually a user ID. - `username` string: The username of the message sender, if any. - `content` string: The content payload. - `create_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created. - `update_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was last updated. - `persistent` boolean: True if the message was persisted to the channel's history, false otherwise. - `room_name` string: The name of the chat room, or an empty string if this message was not sent through a chat room. - `group_id` string: The ID of the group, or an empty string if this message was not sent through a group channel. - `user_id_one` string: The ID of the first DM user, or an empty string if this message was not sent through a DM chat. - `user_id_two` string: The ID of the second DM user, or an empty string if this message was not sent through a DM chat. - `leaderboard_records` LeaderboardRecord[]: The user's leaderboard records. - `leaderboard_id` string: The ID of the leaderboard this score belongs to. - `owner_id` string: The ID of the score owner, usually a user or group. - `username` string: The username of the score owner, if the owner is a user. - `score` string, int64: The score value. - `subscore` string, int64: An optional subscore value. - `num_score` integer: The number of submissions to this score record. - `metadata` string: Metadata. - `create_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was created. - `update_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was updated. - `expiry_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record expires. - `rank` string, int64: The rank of this record. - `max_num_score` integer: The maximum number of score updates allowed by the owner. - `notifications` ApiNotification[]: The user's notifications. - `id` string: ID of the Notification. - `subject` string: Subject of the notification. - `content` string: Content of the notification in JSON. - `code` integer: Category code for this notification. - `sender_id` string: ID of the sender, if a user. Otherwise 'null'. - `create_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the notification was created. - `persistent` boolean: True if this notification was persisted to the database. - `wallet_ledgers` WalletLedger[]: The user's wallet ledger items. - `id` string: The identifier of this wallet change. - `user_id` string: The user ID this wallet ledger item belongs to. - `changeset` string: The changeset. - `metadata` string: Any associated metadata. - `create_time` string, date-time: The UNIX time when the wallet ledger item was created. - `update_time` string, date-time: The UNIX time when the wallet ledger item was updated. ## 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)