Accounts

​

List Accounts

​

GET /network/v1/account

​

Query Parameters

curl "https://api-staging.internal-aui.io/api/outer-bridge/network/v1/account?page=1&limit=50" \
  -H "auth-token: your-jwt-token" \
  -H "account-id: your-account-id" \
  -H "organization-id: your-org-id" \
  -H "x-aui-client: AUI" \
  -H "x-aui-environment: staging" \
  -H "x-aui-origin: stores"

{
  "status": true,
  "data": {
    "docs": [
      {
        "_id": "string",
        "id": "string",
        "name": "string",
        "niceName": "string",
        "status": "ACTIVE",
        "organization": "string",
        "createdBy": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ],
    "totalDocs": 5,
    "limit": 50,
    "totalPages": 1,
    "page": 1
  },
  "message": "string",
  "statusCode": 200
}

​

Best Practices

• Set organization-id header first — Account listings are scoped to the organization in the header. Ensure you’ve selected the correct organization before listing accounts.
• Cache account lists per org — Accounts are relatively stable. Cache per organization and refresh when switching orgs or on user request.

​

Create Account

​

POST /network/v1/account

​

Request Body

curl -X POST "https://api-staging.internal-aui.io/api/outer-bridge/network/v1/account" \
  -H "Content-Type: application/json" \
  -H "auth-token: your-jwt-token" \
  -H "organization-id: your-org-id" \
  -H "x-aui-client: AUI" \
  -H "x-aui-environment: staging" \
  -H "x-aui-origin: stores" \
  -d '{
    "name": "my-project",
    "status": "ACTIVE",
    "organization": "your-org-id"
  }'

{
  "status": true,
  "data": {
    "_id": "string",
    "id": "string",
    "name": "my-project",
    "niceName": "My Project",
    "status": "ACTIVE",
    "organization": "string",
    "createdBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  },
  "message": "string",
  "statusCode": 200
}

​

Best Practices

• Use kebab-case for name — Account names are used as identifiers. Use lowercase kebab-case (e.g., my-project) for consistency. The API auto-generates a niceName for display.
• One account per project — Use accounts to separate different projects or environments within an organization. Avoid putting unrelated agents in the same account.
• Match organization to header — The organization field in the body must match the organization-id header. Mismatches will result in authorization errors.

​

Get Account

​

GET /network/v1/account/{accountId}

​

Path Parameters

curl "https://api-staging.internal-aui.io/api/outer-bridge/network/v1/account/account-id-here" \
  -H "auth-token: your-jwt-token" \
  -H "account-id: your-account-id" \
  -H "organization-id: your-org-id" \
  -H "x-aui-client: AUI" \
  -H "x-aui-environment: staging" \
  -H "x-aui-origin: stores"

{
  "status": true,
  "data": {
    "_id": "string",
    "id": "string",
    "name": "string",
    "niceName": "string",
    "status": "ACTIVE",
    "organization": "string",
    "createdBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

​

Best Practices

• Use to validate context after switching — Call this after switching accounts to confirm the account exists, is active, and belongs to the expected organization.