aboves
List or get organizational hierarchy levels above units, such as regions or divisions, with optional filtering and pagination.
Instructions
Look up organizational hierarchy levels above units — regions, divisions, areas, districts, or any custom grouping configured in the academy. Use this for org hierarchy above the unit level. For units themselves (stores, locations, departments), use the units tool instead.
Sub-actions:
list: List all Above Units with optional filtering by type or search term. Supports pagination.
get: Get details of a single Above Unit by ID, including name, type, external ID, and parent information.
Returns JSON: { data, _meta: { tool, action, returned, truncated? } }. When truncated is true, apply filters or pagination params to narrow results.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | The sub-action to perform: 'list' to browse Above Units, 'get' to retrieve a single Above Unit by ID | |
| type_id | No | Filter Above Units by Type ID (e.g. 328339). Use the types tool to discover available type IDs. Used with list action. | |
| search | No | Search by Above Unit title (e.g. 'New York'). Partial match supported. Used with list action. | |
| start | No | Starting position for pagination (e.g. 0). Used with list action. | |
| limit | No | Number of Above Units to return per request. Default: 100, max: 100000. Used with list action. | |
| aboveId | No | Above Unit ID (e.g. 1286994). Required for: get. Set external_id=true if passing an external ID instead of the internal numeric ID. | |
| external_id | No | When true, treats aboveId as an external ID instead of the internal Schoox ID. Default: false. Used with get action. |