List Subaccounts | BCTRL Docs

curl https://api.bctrl.ai/v1/subaccounts \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "data": [
    {
      "createdAt": "2024-04-01T12:00:00Z",
      "defaultSpaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "id": "subacct_1234567890",
      "limits": {
        "maxActiveRuns": 10,
        "maxSpaces": 5,
        "monthlyCreditLimit": 1500.75
      },
      "name": "Engineering Team Subaccount",
      "status": "active",
      "updatedAt": "2024-04-15T08:30:00Z",
      "archivedAt": null,
      "externalId": "subacct-20240401",
      "metadata": {
        "department": "Engineering",
        "region": "us-west-2"
      },
      "usage": {
        "blockedReasons": [
          "monthlySpendLimit"
        ],
        "computedAt": "2024-04-15T09:30:00Z",
        "credits": {
          "breakdown": {
            "aiCredits": 500.25,
            "browserCredits": 300.5,
            "captchaCredits": 100,
            "filesCredits": 200,
            "proxyCredits": 400
          },
          "estimated": 1500.75,
          "limit": 2000,
          "remaining": 499.25,
          "settled": 1200,
          "used": 1500.75
        },
        "isBlocked": true,
        "period": {
          "endsAt": "2024-04-30T23:59:59Z",
          "startedAt": "2024-04-01T00:00:00Z"
        },
        "runs": {
          "active": 7,
          "blocked": true,
          "limit": 10
        },
        "spaces": {
          "blocked": true,
          "limit": 5,
          "used": 5
        },
        "subaccountId": "subacct_1234567890"
      }
    }
  ],
  "nextCursor": "eyJpZCI6InN1YmFjY3RfMTIzNDU2Nzg5MCIsImNyZWF0ZWRBdCI6IjIwMjQtMDQtMTVUMDg6MzA6MDBaIn0"
}

List subaccounts using the simplified response envelope. Pass include=usage to inline current usage.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Query parameters

cursorstringOptional>=1 character

limitintegerOptional<=200Defaults to 50

include"usage" or list of "usage"Optional

status"active" or "archived"Optional

externalIdstringOptional1-200 characters

querystringOptional1-200 characters

Response

datalist of objects

nextCursorstring or null

Errors

401

Unauthorized Error

403

Forbidden Error