Cakemail icon

Cakemail

Interact with Cakemail API

Sub-Account → List

AI-generated

Summary

List sub-accounts associated with the authenticated account or a specified account ID.

Inputs

  • accountId — Optional: Specify an account ID for multi-tenant operations. If not provided, uses the authenticated account.
  • returnAll — Whether to return all results or only up to a given limit.
  • limit — Max number of results to return, effective only if returnAll is false.
  • additionalFields — Optional fields to filter or sort the results.

Output shape

a list of sub-accounts

Returns either all sub-accounts or a limited set based on the provided limit parameter. If returnAll is set to false, the limit is applied.

Examples

Example 1: List all sub-accounts

Set returnAll to true to get all sub-accounts.

Example 2: Limit the number of results

Set returnAll to false and provide a limit to restrict the output.

Discussion