CakemailInstall

Summary

List accounts filtered by status, account type, parent account ID, and search query with pagination support.

Inputs

• Account ID — Optional: Specify an account ID for multi-tenant operations. If not provided, uses the authenticated account.
• Filters — Filter accounts by status (Active, Suspended, Deleted), account type (Parent, Child, Standalone), parent account ID, or search by name or email. Also supports pagination with page number and results per page.

Output shape

a JSON object representing the list of accounts matching the specified filters and pagination. Each account object includes details as defined by the Cakemail API.

Usage of Account ID is optional and intended for multi-tenant scenarios. Filters are optional; if omitted, defaults to listing active standalone accounts. Pagination is controlled by 'page' and 'per_page' within filters. Error responses will be included if the API call fails.

Examples

Example 1: List active standalone accounts on page 1 with 20 results per page.

Filters: status=active, account_type=standalone, page=1, per_page=20.