Cakemail icon

Cakemail

Interact with Cakemail API

Segment → List Contacts

AI-generated

Summary

List contacts in a specified segment from a Cakemail list.

Inputs

  • accountId — Optional: Specify an account ID for multi-tenant operations. If not provided, uses the authenticated account.
  • listId (required) — The ID of the list.
  • segmentId (required) — The ID of the segment.

Output shape

a list of contacts in the specified segment

Returns an array of contact records associated with the specified segment ID in the given list.

Examples

Example 1: List contacts for segment ID 5 in list ID 3.

Set 'listId' to 3 and 'segmentId' to 5. Optionally set 'accountId' if using multi-tenant.

Discussion