List All Budget Groups
list_budget_groupsBrowse and list all available budget groups in the Metadata platform with customizable sorting.
Default results include both switched-on and switched-off groups. Omit status for
inventory and spreadsheet updates; use status=true or status=false only when the user
requests that switch state. Reading a switched-off group does not switch it on.
Paginate through totalPages before declaring a named group missing.
KEYWORDS: budget, group, list, all, browse, spending, allocation, optimization, overview
**DIFFERENCE FROM get_budget_group:**
- get_budget_group: Searches for ONE specific group BY NAME (requires group name input)
- list_budget_groups: Returns a paginated list of groups (supports flexible sorting)
USE THIS TOOL WHEN THE USER ASKS:
- "Show me all budget groups" or "List all budget groups"
- "What budget groups do we have?"
- "Display all available groups"
- "Show groups sorted by [metric]"
- "Which groups have the highest budget?"
- "Show groups by leads generated"
- "List groups sorted by CPL"
- "Order groups by spending"
DO NOT USE if the user:
- Asks for details about a SPECIFIC group by name → use get_budget_group instead
- Wants to find a group by name → use get_budget_group instead
- Says "Find the [specific name] group" → use get_budget_group instead
SORTING OPTIONS:
You can sort by any of these fields (default: totalActiveExperiments descending):
- totalActiveExperiments, monthlyCap, averageDailyBudgetPerExperiment
- spent, totalBudget, endDate, startDate, leads, cpl
SORT ORDER:
- asc: Ascending order (lowest to highest, oldest to newest)
- desc: Descending order (highest to lowest, newest to oldest) [DEFAULT]Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination (0-based). Default: 0 | |
| size | No | Number of results per page. Default: 10 | |
| status | No | Optional switch-state filter: true for switched-on groups, false for switched-off groups. Omit to include both. | |
| sort_by | No | Field to sort budget groups by. Default: totalActiveExperiments | |
| sort_order | No | Sort order - 'asc' (ascending) or 'desc' (descending). Default: desc |