CakemailInstall

Summary

Lists Cakemail users based on optional filters and pagination settings.

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, with a default of 50 and a maximum of 100.
• additionalFields — Collection of additional optional fields for filtering and sorting results.

Output shape

a list of users

Can return all users if 'returnAll' is true or limited by 'limit'. Optional filtering and sorting can be applied.

Examples

Example 1: List all users associated with an account.

Set 'returnAll' to true.

Example 2: List a maximum of 20 users sorted by first name.

Set 'returnAll' to false and 'limit' to 20; select sort for 'First Name (A-Z)'.