Description

List every account on the instance.

Authentication

This endpoint requires a Bearer token in the Authorization header.

• Authorization: Bearer <token>. A valid Portal API session token or API token belonging to an administrator.

Response Schema

The endpoint returns an array of account records.

• id: The unique identifier for the account.
• name: The human-readable account name.
• planInstance: The identifier of the chart instance the account is bound to, or null if unassigned.
• metadata: An object of arbitrary key-value metadata associated with the account.
• createdAt: Timestamp when the account was created, in milliseconds since unix epoch.

Error Responses

• 401 Unauthorized: The Authorization header is missing or the token is not valid.
• 403 Forbidden: The authenticated user is not an administrator.

Example Request
GET https://<your-host>:9909/api/portal/v1/admin/getAllAccounts
Authorization: Bearer <token>

Example Response
Status Code: 200 OK
Response Body:
[
    {
        "id": 1,
        "name": "Default",
        "planInstance": "oem",
        "metadata": {},
        "createdAt": 1736942400000
    },
    {
        "id": 42,
        "name": "Zydro Marine",
        "planInstance": "oem",
        "metadata": {},
        "createdAt": 1736942400000
    }
]