---
title: "List child accounts"
description: "List an account's child accounts."
canonical: https://www.charitips.com/docs/api-reference/list-child-accounts
---

# List child accounts

`GET /v1/accounts/{accountId}/child-accounts`

List an account's child accounts. Only useful when account hierarchy is enabled i.e for platform or entreprise accounts

**Authentication**: Bearer access token.

## Parameters

- `accountId` (string, required)
- `limit` (number, integer, minimum 1, maximum 100): The max number of items to return.
- `cursor` (string, UUID): The id of the last item from the previous page. Used to fetch the next page.
- `includeUsers` (boolean): Include child accounts' users
- `includeBillingInfo` (boolean): Include child accounts' billing info
- `includeMetrics` (boolean): Include metrics
- `search` (string, at least 3 characters): Full text search on the name field. Minimum length: 3
- `sort` (string): Sorting field and order One of `createdAt:asc`, `createdAt:desc`, `name:asc`, `name:desc`, `metrics.claimedDonationsVolume:asc`, `metrics.claimedDonationsVolume:desc`, `invoices._count:asc`, `invoices._count:desc`, `fiscalReceipts._count:asc`, `fiscalReceipts._count:desc`.
- `includeInvoicesCount` (boolean): Include invoices count
- `includeFiscalReceiptsCount` (boolean): Include fiscal receipts count

## Response 200

- `accountId` (string, required)
- `name` (string, required)
- `status` (AccountStatus, required) One of `PENDING`, `VALIDATED`, `CLOSED`.
- `type` (AccountType, required) One of `INDIVIDUAL`, `COMPANY`.
- `logoUrl` (string)
- `faviconUrl` (string)
- `titleColor` (string)
- `accentColor` (string)
- `headcount` (string)
- `authSchemes` (AuthScheme[], required)
- `parentAccountId` (string)
- `linkedAccountId` (string)
- `createdAt` (string (date-time), required)
- `updatedAt` (string (date-time), required)

## Errors

- 400 `A field is missing, has the wrong type, or is not part of the request schema.`: `message` lists every problem. Unknown fields are rejected, not ignored: remove them rather than sending extra data. See https://www.charitips.com/docs/api-reference/errors.md.
- 401 `Unauthorized`: The access token is missing, expired or invalid. Create a new one with your client id and secret, send it as `Authorization: Bearer <accessToken>`, then retry once. Sandbox tokens only work on api.sandbox.charitips.com. See https://www.charitips.com/docs/get-started/authentication.md.
- 403 `Account closed`: The account behind these credentials is closed: no token is issued and every call is refused, reads included. Contact Charitips to reopen it. See https://www.charitips.com/docs/api-reference/troubleshooting.md#calls-answer-403-account-not-active-account-not-validated-or-account-closed.

## Example

```bash
curl -X GET https://api.sandbox.charitips.com/v1/accounts/<accountId>/child-accounts \
  -H "Authorization: Bearer $CHARITIPS_TOKEN"
```

```javascript
const response = await fetch('https://api.sandbox.charitips.com/v1/accounts/<accountId>/child-accounts', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.CHARITIPS_TOKEN}`,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const data = await response.json();
```

```python
import os, requests

response = requests.get(
    "https://api.sandbox.charitips.com/v1/accounts/<accountId>/child-accounts",
    headers={"Authorization": f"Bearer {os.environ['CHARITIPS_TOKEN']}"},
)
response.raise_for_status()
data = response.json()
```

## Response example (200, placeholder values)

```json
[
  {
    "accountId": "<accountId>",
    "name": "<name>",
    "status": "PENDING",
    "type": "INDIVIDUAL",
    "logoUrl": "<logoUrl>",
    "faviconUrl": "<faviconUrl>",
    "titleColor": "<titleColor>",
    "accentColor": "<accentColor>"
  }
]
```