Cakemail icon

Cakemail

Interact with Cakemail API

Segment → Get

AI-generated

Summary

Fetch the details of a specific segment by its ID within a given 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 single segment record

Returns the details of the segment identified by segmentId in the specified list. If segmentId or listId are invalid, an error will be returned.

Examples

Example 1: Retrieve segment details for a specific marketing list.

Set the listId to the ID of the marketing list and the segmentId to the ID of the segment you want to fetch.

Discussion