CakemailInstall

Summary

List contacts from Cakemail based on specified filters and pagination.

Inputs

• accountId — Optional: Specify an account ID for multi-tenant operations. If not provided, uses the authenticated account.
• filters (required) — Collection of filters to apply when listing contacts, including status, list membership, search terms, tags, and pagination options.

Output shape

a list of contacts matching the specified filters

Includes pagination capabilities through 'page' and 'per_page' parameters. Default values are provided for filters.

Examples

Example 1: List of active contacts

Set 'filters.status' to 'active' and 'per_page' to 10.

Example 2: List contacts with specific tags

Set 'filters.tags' to 'vip, customer' and 'per_page' to 50.