listChildAccounts( )


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.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Get Sub Accounts
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsListChildAccountsOptions

Filter options.

Returns
Return Type:Promise<ListChildAccountsResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?