Cakemail icon

Cakemail

Interact with Cakemail API

Contact → Search

AI-generated

Summary

Search contacts based on customized criteria using advanced filtering options.

Inputs

  • accountId — Optional: Specify an account ID for multi-tenant operations. If not provided, uses the authenticated account.
  • searchQuery (required) — Advanced search query with filters and operators. Use JSON format to specify attributes such as company, tags, and status.
  • searchOptions — Collection of additional options for searching, including pagination, sorting fields, and sort order.

Output shape

a list of matching contacts

Returns an array of contact objects matching the search criteria, including all specified fields. Supports pagination and sorting based on the provided options.

Discussion