> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getnexor.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List sub-accounts

> List your sub-accounts with their state, owner, tasks, leads, and the leads each one contacted this period against your plan.

A sub-account is a separate Nexor account that belongs to your account. It has its own team, agents, numbers, conversations, and leads, and every lead it contacts counts toward your plan. See [Sub-accounts](/docs/en/guides/account/sub-accounts).

The main account is always the account that owns the API key. There is no parameter to act on behalf of another account.

## Read the response

| `state` | Meaning |
| - | - |
| `active` | The sub-account is working normally. |
| `invited` | The owner has not joined yet. `owner.invitation_expires_at` shows when the invitation expires. |
| `paused` | The sub-account has tasks and none of them is live. |
| `inactive` | The sub-account was deactivated. Its team cannot see it. |

* `agents_active` and `agents_total` count tasks (`workflow` in the API), not agents.
* `contacted_period` is what one sub-account contacted this period. `family.used` adds up the main account and all its sub-accounts, and is the number compared with `family.quota`.
* `null` in `period`, `family`, or `contacted_period` means the usage meter could not be read. It does not mean zero.

## Before you start

* Sub-accounts are an optional feature that Nexor enables on request. Without it, every endpoint in this section returns 403 `sub_accounts_not_enabled`. Contact Nexor Support to request it.
* Use an API key of the main account. A key that belongs to a sub-account gets 403 `sub_account_cannot_manage_sub_accounts`, because a sub-account cannot have sub-accounts of its own.
* MCP keys need `sub-accounts:read` to list and `sub-accounts:write` for every other operation. Full-access API keys need nothing else.
* Every change requires `"confirm": true` in the body. Without it, the API returns 400 `confirmation_required` and changes nothing.
* An ID that is not one of your sub-accounts returns 403 `not_parent_of_client`.
* Errors return a stable code in `error`, such as `owner_email_invalid`. Map the code to your own message.


## API Specification

The full API specification for this endpoint is available in the [documentation index](https://docs.getnexor.ai/llms.txt).