LiveRecoverVYG Developer Docs
MCPToolsCDP tools

Segment Members

List a segment's members, or just its size

cdp_segment_members

Lists the members of a saved segment owned by your brand, or — with countOnly — just the membership size. Pass the segmentId from cdp_list_segments; page with limit/offset, or pass the opaque cursor to walk deep pages.

Read-only and scoped to your brand.

Parameters

NameTypeRequiredDescriptionDefault
segmentIdstringYesThe segment id from cdp_list_segments.
limitnumberNoPage size (1–100).25
offsetnumberNoOffset for offset-based paging.0
cursorstringNoOpaque deep-pagination position (the last member itemId of the previous page).
countOnlybooleanNoWhen true, return only the membership count and skip reading a page.false

Returns

When listing members:

  • segmentId, list — the member profiles.
  • identities — a map of profile itemId → derived identity (email / phone / name).
  • totalSize, offset, pageSize — paging metadata.
  • nextCursor — the last member itemId when a full page was returned (pass it back as cursor to walk the next page), or null when the page is exhausted.
  • scope — your brand's shop domain.

When countOnly is true:

  • segmentId, count, scope.

Example prompts

How many customers are in my "VIP" segment?
List the members of segment seg_123

Notes

  • Only in-scope profiles are ever returned.
  • An id that isn't one of your brand's segments returns an empty page (or not-found when countOnly), never another brand's members.
  • Use countOnly when you only need the size — it skips reading a profile page.

On this page