Accounts

A service that provides features for the management of accounts

Experimental feature: this API is likely to change.

Service health check

GEThttps://your-organization-id.m2worlds.io/api/accounts/healthz/

Response

200

Provides information about the service status.

Body

application/json

statusMessage (string)

Provides information about the service status.

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/accounts/healthz/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Fetch a user's account

Retrieves and returns the account information for the specified user. An email address and wallet address will only be returned if the user has verified them.

This API can be called by the user themselves, the Unreal server, or any user with read permissions on the organization's user profiles.

GEThttps://your-organization-id.m2worlds.io/api/accounts/users/{userId}/

Authorization

BearerAuth

Path parameters

userId*string

The user ID to fetch the account for

Header parameters

Response

2004XX

The response to querying a user's account information

Body

application/json

evmLinkedWalletstring

The verified EVM wallet linked by this user

emailstring

The verified email address associated with this user

isGuest*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/accounts/users/{userId}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

2004XX

{
  "evmLinkedWallet": "text",
  "email": "text",
  "isGuest": false
}