coss.comdocs

List sub-accounts

GET
/v1/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.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.

Query Parameters

limit?integer

1-100, default 50.

Range1 <= value <= 100
after?string

The last id of the previous page.

Header Parameters

Coss-Version?"2026-10-10"

The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.

Value in"2026-10-10"

Response Body

A page of sub-accounts.

application/json
  1. response
object*"list"
Value in"list"
data*array<>
has_more*boolean
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();
{  "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}