> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://platform.bctrl.ai/llms.txt.
> For full documentation content, see https://platform.bctrl.ai/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://platform.bctrl.ai/_mcp/server.

# List Subaccounts

GET https://api.bctrl.ai/v1/subaccounts

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

Reference: https://platform.bctrl.ai/api/api-reference/account/subaccounts

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v1/subaccounts:
    get:
      operationId: subaccounts-list
      summary: List subaccounts
      description: >-
        List subaccounts using the simplified response envelope. Pass
        include=usage to inline current usage.
      tags:
        - subpackage_account
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            type: string
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 50
        - name: include
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/V1SubaccountsGetParametersInclude'
        - name: status
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/V1SubaccountsGetParametersStatus'
        - name: externalId
          in: query
          required: false
          schema:
            type: string
        - name: query
          in: query
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: Use Bearer <api-key>.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubaccountListResponse'
        '401':
          description: 'Authentication required: the API key is missing or invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Forbidden: the API key cannot access this resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
servers:
  - url: https://api.bctrl.ai
    description: Production
  - url: http://localhost:8787
    description: Local development gateway
components:
  schemas:
    V1SubaccountsGetParametersInclude:
      oneOf:
        - type: string
          enum:
            - usage
        - type: array
          items:
            type: string
            enum:
              - usage
      title: V1SubaccountsGetParametersInclude
    V1SubaccountsGetParametersStatus:
      oneOf:
        - type: string
          enum:
            - active
        - type: string
          enum:
            - archived
      title: V1SubaccountsGetParametersStatus
    SubaccountLimits:
      type: object
      properties:
        maxActiveRuns:
          type:
            - integer
            - 'null'
        maxSpaces:
          type:
            - integer
            - 'null'
        monthlyCreditLimit:
          type:
            - number
            - 'null'
          format: double
      required:
        - maxActiveRuns
        - maxSpaces
        - monthlyCreditLimit
      title: SubaccountLimits
    SubaccountMetadata:
      type: object
      properties: {}
      title: SubaccountMetadata
    SubaccountStatus:
      type: string
      enum:
        - active
        - archived
      title: SubaccountStatus
    SubaccountUsageBlockedReasonsItems:
      type: string
      enum:
        - monthlySpendLimit
        - activeRunLimit
        - spaceLimit
      title: SubaccountUsageBlockedReasonsItems
    SubaccountUsageBreakdown:
      type: object
      properties:
        aiCredits:
          type: number
          format: double
        browserCredits:
          type: number
          format: double
        captchaCredits:
          type: number
          format: double
        filesCredits:
          type: number
          format: double
        proxyCredits:
          type: number
          format: double
      required:
        - aiCredits
        - browserCredits
        - captchaCredits
        - filesCredits
        - proxyCredits
      title: SubaccountUsageBreakdown
    SubaccountUsageCredits:
      type: object
      properties:
        breakdown:
          $ref: '#/components/schemas/SubaccountUsageBreakdown'
        estimated:
          type: number
          format: double
        limit:
          type:
            - number
            - 'null'
          format: double
        remaining:
          type:
            - number
            - 'null'
          format: double
        settled:
          type: number
          format: double
        used:
          type: number
          format: double
      required:
        - breakdown
        - estimated
        - limit
        - remaining
        - settled
        - used
      title: SubaccountUsageCredits
    SubaccountUsagePeriod:
      type: object
      properties:
        endsAt:
          type: string
          format: date-time
        startedAt:
          type: string
          format: date-time
      required:
        - endsAt
        - startedAt
      title: SubaccountUsagePeriod
    SubaccountUsageRuns:
      type: object
      properties:
        active:
          type: integer
        blocked:
          type: boolean
        limit:
          type:
            - integer
            - 'null'
      required:
        - active
        - blocked
        - limit
      title: SubaccountUsageRuns
    SubaccountUsageSpaces:
      type: object
      properties:
        blocked:
          type: boolean
        limit:
          type:
            - integer
            - 'null'
        used:
          type: integer
      required:
        - blocked
        - limit
        - used
      title: SubaccountUsageSpaces
    SubaccountUsage:
      type: object
      properties:
        blockedReasons:
          type: array
          items:
            $ref: '#/components/schemas/SubaccountUsageBlockedReasonsItems'
        computedAt:
          type: string
          format: date-time
        credits:
          $ref: '#/components/schemas/SubaccountUsageCredits'
        isBlocked:
          type: boolean
        period:
          $ref: '#/components/schemas/SubaccountUsagePeriod'
        runs:
          $ref: '#/components/schemas/SubaccountUsageRuns'
        spaces:
          $ref: '#/components/schemas/SubaccountUsageSpaces'
        subaccountId:
          type: string
      required:
        - blockedReasons
        - computedAt
        - credits
        - isBlocked
        - period
        - runs
        - spaces
        - subaccountId
      title: SubaccountUsage
    Subaccount:
      type: object
      properties:
        archivedAt:
          type:
            - string
            - 'null'
        createdAt:
          type: string
        defaultSpaceId:
          type: string
          format: uuid
        externalId:
          type:
            - string
            - 'null'
        id:
          type: string
        limits:
          $ref: '#/components/schemas/SubaccountLimits'
        metadata:
          oneOf:
            - $ref: '#/components/schemas/SubaccountMetadata'
            - type: 'null'
        name:
          type: string
        status:
          $ref: '#/components/schemas/SubaccountStatus'
        updatedAt:
          type: string
        usage:
          $ref: '#/components/schemas/SubaccountUsage'
      required:
        - createdAt
        - defaultSpaceId
        - id
        - limits
        - name
        - status
        - updatedAt
      title: Subaccount
    SubaccountListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Subaccount'
        nextCursor:
          type:
            - string
            - 'null'
      required:
        - data
        - nextCursor
      title: SubaccountListResponse
    ErrorResponseReasonClass:
      type: string
      enum:
        - invalid_input
        - unauthorized
        - capability_denied
        - capability_limit_exceeded
        - rate_limited
        - not_found
        - conflict
        - upstream
        - server
      description: Stable public error category for programmatic branching.
      title: ErrorResponseReasonClass
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: >-
            Stable, dot-namespaced error code, e.g. "runtime.not_found" or
            "request.invalid".
        details:
          type: object
          additionalProperties:
            description: Any type
          description: >-
            Resource-specific structured context. Use `code` and `reasonClass`
            for branching.
        error:
          type: string
        hint:
          type: string
          description: Optional next action for recoverable errors, e.g. "retry after 2s".
        reasonClass:
          $ref: '#/components/schemas/ErrorResponseReasonClass'
          description: Stable public error category for programmatic branching.
        requestId:
          type: string
      required:
        - code
        - error
      title: ErrorResponse
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## Examples



**Request**

```json
{}
```

**Response**

```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"
}
```

**SDK Code**

```python
import requests

url = "https://api.bctrl.ai/v1/subaccounts"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/subaccounts';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bctrl.ai/v1/subaccounts"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.bctrl.ai/v1/subaccounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.bctrl.ai/v1/subaccounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.bctrl.ai/v1/subaccounts', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/subaccounts");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/subaccounts")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```