Cakemail icon

Cakemail

Interact with Cakemail API

Interest → List

AI-generated

Summary

Lists interests associated with a specified account in Cakemail.

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. Defaults to 50, maximum of 100.
  • additionalFields — Additional fields for configuration such as sorting options.

Output shape

a list of interests

Returns either all interests or a limited set based on the 'limit' parameter. If 'returnAll' is false, the limit must be specified.

Examples

Example 1: If a user wants to fetch all interests for the authenticated account, they can simply leave 'accountId' blank and set 'returnAll' to true.

This will return all interests associated with the account.

Example 2: To retrieve a specific number of interests, a user should set 'returnAll' to false and specify a number in the 'limit' field.

For example, setting 'limit' to 20 will return only the first 20 interests.

Discussion