list_groups
Retrieve a paginated, read-only list of trading account groups, filtered by code, notes, block reason, status, position or account counts and trading-connection access, with sorting.
Instructions
Return one page of account groups; each row is the group row of the REST group list. The first page also carries the default group when it matches the filters, outside the limit and the total. Read-only - no secrets, no order-flow control. Filters: code (code or title), notes and blockReason (text match), status (active | blocked), position (open-position count range), account (member-account count range); venue is the trading-connection filter: mode any (through at least one trading connection), none (through no connection) or connection (through the connection whose id is in connection). Sort columns: accountCount, blockReason, code, notes, positionCount, status, title, venueAccess. Paging: limit rows per page (default 50, capped at 500) and a 1-based page; total counts the matching rows before paging. An invalid value fails with a validation error.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Group code or title match | |
| page | No | 1-based page number, default 1 | |
| sort | No | Sort order | |
| limit | No | Rows per page, default 50, capped at 500 | |
| notes | No | Group notes match | |
| venue | No | Trading-connection filter on the group's own grants | |
| status | No | Block state: active | blocked; omitted = both | |
| account | No | Member-account count range | |
| position | No | Open-position count range | |
| blockReason | No | Block reason match |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| total | Yes | ||
| groups | Yes |