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

List users

GET

https://api.eu-west-1.aworld.cloud/dashboard/v1/users

Users

Retrieves a paginated list of users available in the workspace

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "items": [
        {
            "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"
        }
    ],
    "nextToken": "string"
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

nextToken

string

optional

Pagination token for fetching the next set of results

limit

integer

optional

Maximum number of users to return per page

Default:

Responses

🟢200OK

application/json

List of users retrieved successfully

Body

items

array[object (User) {9}]

optional

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

nextToken

string

optional

Pagination token for the next set of results

🟠401Unauthorized

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

Publish a tag

Create user