List Segments
list_segmentsList a page of visible, non-archived saved segments with subtype, status, and record counts. Use when the user asks what segments they have; filter by subtype or pass a limit of 1–100. For one complete definition, call get_segment with its segment_id. Requires 'discovery' scope.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_segments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of segments to return (default 10; maximum 100) | |
| cursor | No | next_cursor from a previous response | |
| compact | No | Return small summaries by default. Set false to include saved filter_groups on filter segments; get_segment retrieves one complete definition. | |
| subtype | No | Optional: filter results to a specific segment subtype; custom is materialized membership published by the data team. | |
| include_archived | No | Include archived objects so they can be found and restored |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| total | Yes | Number of segments on this page | |
| guidance | No | Interpretation or recovery guidance for this result | |
| segments | Yes | Saved segment summaries | |
| count_unit | No | ||
| page_count | No | Number of objects on this page, not the organization total | |
| count_state | No | Unknown means no count; available does not guarantee freshness. Recount for a current value. | |
| next_cursor | Yes | Cursor for the next page, or null | |
| next_actions | No | Suggested next calls using returned IDs and available scopes. Not executed and not user consent. | |
| population_input | No | Population input used for the preview; IDs refer to their current saved definitions |