> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# listChildAccounts

# Package: accounts

# Namespace: AccountService

# Method link: https://dev.wix.com/docs/api-reference/account-level/accounts/list-child-accounts.md

## Introduction

Retrieves a list of child account IDs for the requesting account.
If no child accounts exist, an empty list will be returned.

> **Important**: This call requires an account level API key.

---

## REST API

### Schema

```
 Method: listChildAccounts
 Description: Retrieves a list of child account GUIDs for the requesting account. If no child accounts exist, an empty list will be returned.  > **Important**: This call requires an account level API key.
 URL: https://www.wixapis.com/accounts/v1/account/child-accounts
 Method: GET
 Method parameters:
   param name: paging | type: Paging    
        - name: limit | type: integer | description: Number of items to load.  | validation: minimum 0, format int32
        - name: offset | type: integer | description: Number of items to skip in the current sort order.  | validation: minimum 0, format int32
 Return type: ListChildAccountsResponse
  - name: childAccounts | type: array<AccountV2> | description: The requested child accounts.  
     - name: accountId | type: string | description: Account GUID.  | validation: format GUID
  - name: pagingMetadata | type: PagingMetadata | description: Metadata of the response pagination.  
     - name: count | type: integer | description: Number of items returned in the response.  | validation: format int32
     - name: offset | type: integer | description: Offset that was requested.  | validation: format int32
     - name: total | type: integer | description: Total number of items that match the query.  | validation: format int32
     - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field.  


```

### Examples

### List child accounts
```curl
curl -X GET \
'https://www.wixapis.com/accounts/v1/account/child-accounts' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.userManagement.accounts.listChildAccounts(options)
 Description: Retrieves a list of child account GUIDs for the requesting account. If no child accounts exist, an empty list will be returned.  > **Important**: This call requires an account level API key.
 Method parameters:
   param name: options | type: listChildAccountsOptions  none  
        - name: paging | type: Paging | description: Paging options to limit and offset the number of items. Default: 20. Max: 50.  
           - name: limit | type: integer | description: Number of items to load.  | validation: minimum 0, format int32
           - name: offset | type: integer | description: Number of items to skip in the current sort order.  | validation: minimum 0, format int32
 Return type: PROMISE<ListChildAccountsResponse>
  - name: childAccounts | type: array<AccountV2> | description: The requested child accounts.  
     - name: accountId | type: string | description: Account GUID.  | validation: format GUID
  - name: pagingMetadata | type: PagingMetadata | description: Metadata of the response pagination.  
     - name: count | type: integer | description: Number of items returned in the response.  | validation: format int32
     - name: offset | type: integer | description: Offset that was requested.  | validation: format int32
     - name: total | type: integer | description: Total number of items that match the query.  | validation: format int32
     - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field.  


```

### Examples

### listChildAccounts
```javascript
import { accounts } from '@wix/user-management';

async function listChildAccounts(options) {
  const response = await accounts.listChildAccounts(options);
};
```

### listChildAccounts (with elevated permissions)
```javascript
import { accounts } from '@wix/user-management';
import { auth } from '@wix/essentials';

async function myListChildAccountsMethod(options) {
  const elevatedListChildAccounts = auth.elevate(accounts.listChildAccounts);
  const response = await elevatedListChildAccounts(options);
}
```

### listChildAccounts (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { accounts } from '@wix/user-management';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { accounts },
  // Include the auth strategy and host as relevant
});


async function listChildAccounts(options) {
  const response = await myWixClient.accounts.listChildAccounts(options);
};
```

---