CakemailInstall

Summary

List campaigns from Cakemail based on optional filters and sorting criteria.

Inputs

• accountId — Optional: Specify an account ID for multi-tenant operations. If not provided, uses the authenticated account.
• filter — Filter campaigns using query syntax. Valid fields: status, name, type, list_id. Use == operator and ; to combine.
• sort — Sort campaigns by field. Use + for ascending or - for descending order.

Output shape

a list of campaign objects

Returns campaign details based on specified filters and sorting. Use pagination if the number of campaigns exceeds limits.

Examples

Example 1: Retrieve all campaigns

This operation fetches a list of campaigns without any specific filters.

Example 2: Retrieve sent campaigns

Use the 'filter' parameter with 'status==sent' to get only campaigns that have been sent.

Example 3: Sort campaigns by creation date

Apply the 'sort' parameter as '-created_on' to get the most recently created campaigns first.