# List sub-accounts (/docs/api-reference/sub-accounts/list-subaccounts)

The environment's sub-accounts, newest first. Sub-accounts belong to the API key's own environment: a `coss_test_…` key only ever sees sandbox ones, a `coss_live_…` key only production ones.

`GET https://api.coss.com/v1/subaccounts`

Authenticate with your API key as a bearer token (`Authorization: Bearer coss_test_…`). Responses are JSON with snake_case fields; errors are `{ error: { type, code, message, param?, issues?, request_id } }` (https://coss.com/docs/api-reference/errors.md).

## Query parameters

- `limit` (integer, 1-100): 1-100, default 50.
- `after` (string): The last `id` of the previous page.

## Example request

TypeScript (the `coss` package):

```ts
import { Coss } from "coss";

const coss = new Coss({
  apiKey: process.env.COSS_API_KEY,
  baseUrl: "https://api.coss.com",
});

const { data, error } = await coss.email.subaccounts.list({
  after: "sub_01k7c8m4q2f3e9v6t5r1n0p8yz",
});
```

HTTP:

```sh
curl -X GET "https://api.coss.com/v1/subaccounts?after=sub_01k7c8m4q2f3e9v6t5r1n0p8yz" \
  -H "Authorization: Bearer $COSS_API_KEY"
```

Python:

```python
from coss import Coss

client = Coss()  # api_key= or COSS_API_KEY

client.email.subaccounts.list(
    after="sub_01k7c8m4q2f3e9v6t5r1n0p8yz",
)
```

Go:

```go
import (
	"context"

	coss "github.com/cosscom/coss-go"
	cossclient "github.com/cosscom/coss-go/client"
	email "github.com/cosscom/coss-go/email"
)

client := cossclient.NewClient() // option.WithAPIKey(…) or COSS_API_KEY

request := &email.ListSubaccountsRequest{
    After: coss.String(
        "sub_01k7c8m4q2f3e9v6t5r1n0p8yz",
    ),
}
client.Email.Subaccounts.List(
    context.TODO(),
    request,
)
```

Ruby:

```ruby
require "coss"

client = Coss::Client.new # api_key: or COSS_API_KEY

client.email.subaccounts.list(after: "sub_01k7c8m4q2f3e9v6t5r1n0p8yz")
```

PHP:

```php
<?php

use Coss\Coss;
use Coss\Email\Subaccounts\Requests\ListSubaccountsRequest;

$client = new Coss(); // apiKey: or COSS_API_KEY

$client->email->subaccounts->list(
    new ListSubaccountsRequest([
        'after' => 'sub_01k7c8m4q2f3e9v6t5r1n0p8yz',
    ]),
);
```

Java:

```java
import com.coss.Coss;
import com.coss.resources.email.subaccounts.requests.ListSubaccountsRequest;

Coss client = Coss.builder().build(); // .apiKey(…) or COSS_API_KEY

client.email().subaccounts().list(
    ListSubaccountsRequest
        .builder()
        .after("sub_01k7c8m4q2f3e9v6t5r1n0p8yz")
        .build()
);
```

.NET:

```csharp
using Coss;
using Coss.Email;

var client = new CossClient(); // apiKey: or COSS_API_KEY

await client.Email.Subaccounts.ListAsync(
    new ListSubaccountsRequest { After = "sub_01k7c8m4q2f3e9v6t5r1n0p8yz" }
);
```

## Response 200

A page of sub-accounts.

- `object` ("list", required)
- `data` (object[], required)
  - `object` ("subaccount", required)
  - `id` (string, required)
  - `uid` (string | null, required): Your own id for it (e.g. your user's id), unique in the environment. Every path and send that takes a sub-account accepts its `id` or its `uid`.
  - `name` (string, required)
  - `metadata` (map of string, required)
  - `status` ("active" | "disabled" | "deleting", required): `disabled`: you turned it off (its sends are refused). `deleting`: its domains are being released.
  - `quotas` (object, required)
    - `recipients_per_day` (integer | null, required, 1-100000000): Recipients it may send to per day; `null`: only your organization's quota.
    - `recipients_per_second` (integer | null, required, 1-100000000): Recipients it may send to per second; `null`: only your organization's quota.
    - `burst` (integer | null, required, 1-100000000): How many recipients a moment may take before the per-second rate applies; `null`: the per-second rate.
  - `reputation` (object, required)
    - `status` ("good" | "warning" | "paused", required): `warning`: a rate is close to its limit. `paused`: its live sends are refused (`subaccount_paused`) until you reinstate it.
    - `trigger` (string | null, required): What last changed it, e.g. `bounce_rate`, `complaint_rate`, `content_screening`.
    - `changed_at` (string | null, required, date-time)
    - `reinstated_at` (string | null, required, date-time)
  - `created_at` (string, required, date-time)
  - `updated_at` (string, required, date-time)
- `has_more` (boolean, required)

Example:

```json
{
  "object": "list",
  "data": [
    {
      "object": "subaccount",
      "id": "sub_01k7c8m4q2f3e9v6t5r1n0p8yz",
      "uid": "user_8812",
      "name": "Acme Bakery",
      "metadata": {
        "plan": "pro"
      },
      "status": "active",
      "quotas": {
        "recipients_per_day": 5000,
        "recipients_per_second": 5,
        "burst": 50
      },
      "reputation": {
        "status": "good",
        "trigger": null,
        "changed_at": null,
        "reinstated_at": null
      },
      "created_at": "2026-01-15T09:30:00.000Z",
      "updated_at": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false
}
```

## Errors

- `400`: The `Coss-Version` header names an unknown API version (`invalid_api_version`).
- `401`: The API key is missing, invalid, revoked or expired (`authentication_error`).
- `403`: The API key lacks the permission this endpoint needs (`permission_error`), or its organization is suspended (`organization_suspended`).
- `429`: Too many requests with this API key (`rate_limited`), or too many requests with invalid keys from this address (`too_many_failed_authentications`). Retry after `Retry-After` seconds. Successful responses carry `RateLimit-Limit`, `RateLimit-Remaining` and `RateLimit-Reset` (seconds until the limit is fully restored).
- `500`: Unexpected server error (`api_error` / `internal_error`).
- `503`: The API key could not be verified right now; retry (`service_unavailable`).