customers toolset
list_segments
List segments. Lists saved segments (named groups of customers defined by rules) with their rules and how many users match now. Use a segment's name in filters (voter_segment) and in list_voters. Team only. No side effects.
- Toolset
- customers
- Who can call it
- OwnersManagersContributorsAPI keys
- REST
GET /api/v1/w/{workspace}/segments- Behavior
- read-onlyidempotent
Input
No input.
Output
| Field | Type | Description |
|---|---|---|
itemsrequired | array of object |
Calling it
// MCP: tools/call
{ "name": "list_segments", "arguments": {} }
// Typed client
await carechannel.list_segments({});