List Audience Segmentations
list_formationsLists visible Audience segmentations with Formation/subgroup IDs and counts for respondent filters. Ready counts are final. Paged (limit 1–100, default 100); pagination.nextOffset continues while hasMore.
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_formations"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| groupId | No | Legacy alias for audienceId. Accepted for compatibility. | |
| groupName | No | Legacy alias for audienceName. Accepted for compatibility. | |
| audienceId | No | Audience ID (UUID). Preferred when known. | |
| audienceName | No | Audience name: exact or partial (case-insensitive), with a fuzzy fallback for typos. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| audienceId | No | Audience whose visible segmentations were listed. | |
| formations | No | Visible segmentations: id, name, status, source, dimensionKey, and subgroups with id, label, memberCount and isAuxiliary. Ready Formation/subgroup IDs identify respondent filters. | |
| pagination | No | Page metadata: total, limit, offset, hasMore and nextOffset. | |
| totalCount | No | Total number of visible segmentations across all pages. |