List sub-accounts

Changed on

List sub-accounts in the workspace associated with the API key. Archived sub-accounts are excluded by default. This workspace-level management request must not include the Sub-Account-ID header.

get/sub-accounts

Request

Query parameters

archivedboolean

Whether to include archived sub-accounts in addition to active sub-accounts.

Response

OK

idstring uuid required

The sub-account ID. Use this value in the Sub-Account-ID header for scoped API calls.

workspace_idstring uuid required

The ID of the workspace that owns the sub-account.

namestring required

The sub-account name.

archivedboolean required

Whether the sub-account is archived.

created_atstring date-time required

When the sub-account was created.

updated_atstring date-time required

When the sub-account was last updated.

Example response

[
  {
    "id": "70ff6a88-6291-417d-b6cd-04f1ca123470",
    "workspace_id": "2db5ea61-1752-42cf-8ea1-ab1da060cd0a",
    "name": "Acme Europe",
    "created_at": "2026-08-05T09:30:00Z",
    "updated_at": "2026-08-05T09:30:00Z"
  }
]

Changes