AWorld APIs are in a pre-alpha stage and are being updated frequently. For integration inquiries or technical information, please contact us at server@aworld.org.

AWorld API

Get user by external ID

GET

https://api.eu-west-1.aworld.cloud/dashboard/v1/users/byExternalId/{externalId}/

Users

Retrieves a specific user by their unique external ID identifier

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.eu-west-1.aworld.cloud/dashboard/v1/users/byExternalId//'

Response Example

{
    "userId": "string",
    "principalId": "string",
    "externalId": "string",
    "lang": "en",
    "timezone": "UTC",
    "accountId": "string",
    "workspaceId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

externalId

string

required

Unique external identifier of the user to retrieve

Responses

🟢200OK

application/json

User retrieved successfully

Body

User account information

userId

string

required

Unique identifier for the user

principalId

string

required

Identifier used for authentication

externalId

string

optional

Optional external system identifier for the user

lang

string

required

User's preferred language code

Default:

timezone

string

required

User's timezone

Default:

UTC

accountId

string

required

The account ID that this user belongs to

workspaceId

string

required

The workspace ID that this user belongs to

createdAt

string <date-time>

optional

Timestamp when the user was created

updatedAt

string <date-time>

optional

Timestamp when the user was last updated

🟠401Unauthorized

🟠404Record Not Found

Modified at 2025-06-26 12:50:58

Get user by ID

List virtual currencies