Administration

Accounts

Retrieve the accounts available to your credentials.
View as Markdown

Accounts are where teams create and manage platform resources, including data, models, configurations, and workspaces.

Accounts are currently created by Umnai during onboarding. Use the API to retrieve the accounts your credentials can access and to inspect a specific account when you already have its id.

Retrieve accounts

Retrieve the accounts available to the current credentials.

GET
/accounts
1curl https://api.hi.umnai.com/accounts \
2     -H "Authorization: Bearer <token>"
Response
1{
2  "data": [
3    {
4      "id": "ea8b745ead39ec442fc3b4fba359bf98",
5      "name": "Sample Organisation",
6      "created_at": "2026-03-11T16:04:19.749000Z",
7      "status": "ACTIVE",
8      "updated_at": null
9    }
10  ],
11  "pagination": {
12    "total_items": 1,
13    "items_per_page": 10,
14    "current_page": 1,
15    "total_pages": 1
16  }
17}

Use the returned account id when creating or retrieving account-scoped resources.

Retrieve an account

Retrieve a specific account by its id.

GET
/accounts/:accountId
1curl https://api.hi.umnai.com/accounts/{accountId} \
2     -H "Authorization: Bearer <token>"
Response
1{
2  "data": [
3    {
4      "id": "ea8b745ead39ec442fc3b4fba359bf98",
5      "name": "Sample Organisation",
6      "status": "ACTIVE",
7      "created_at": "2026-03-11T16:04:19.749000Z",
8      "updated_at": null
9    }
10  ],
11  "pagination": {
12    "total_items": 1,
13    "items_per_page": 10,
14    "current_page": 1,
15    "total_pages": 1
16  }
17}