listChildAccounts( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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 and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
SCOPE.ACCOUNT.BASIC_TEAM_MEMBER
SCOPE.ACCOUNT.OWNER
Get Sub Accounts
Learn more about app permissions.
Method Declaration
Copy
function listChildAccounts(
  options: ListChildAccountsOptions,
): Promise<ListChildAccountsResponse>;
Method Parameters
optionsListChildAccountsOptions

Filter options.

Returns
Return Type:Promise<ListChildAccountsResponse>
List child accounts with an API key
JavaScript
import { createClient, ApiKeyStrategy } from "@wix/sdk";
import { accounts } from "@wix/user-management";
const wixClient = createClient({
  modules: { accounts },
  auth: ApiKeyStrategy({
    apiKey: "MY-API-KEY",
  }),
});

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

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

Did this help?