units
Retrieve organizational units (stores, locations, departments) from the academy hierarchy. List active or archived units with search and pagination, or get details by ID.
Instructions
Look up organizational units (stores, locations, departments) in the academy hierarchy. Units are the lowest level of the organizational structure. Use this for units themselves. For higher-level groupings (regions, divisions, areas), use the aboves tool instead.
Sub-actions:
list: List all active units with optional filtering by search term, parent Above Unit, or Above Unit ID. Supports pagination.
get: Get details of a single unit by ID, including name, external ID, and organizational placement.
list_archived: List archived (inactive) units. Supports pagination.
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' for active units, 'get' for a single unit by ID, 'list_archived' for inactive units | |
| search | No | Search by unit title (e.g. 'Chicago'). Comma-separate multiple terms (e.g. 'Chicago,Boston'). Used with list action. | |
| search_above | No | Filter units by their parent Above Unit title (e.g. 'Northeast Region'). Used with list action. | |
| above_id | No | Filter units by Above Unit ID (e.g. 42). Used with list action. | |
| start | No | Starting position for pagination (e.g. 0). Used with list and list_archived actions. | |
| limit | No | Number of units to return per request. Default: 100, max: 100000. Used with list and list_archived actions. | |
| unitId | No | Unit ID (e.g. '100') or external ID. Required for: get. Set external_id=true if passing an external ID instead of the internal numeric ID. | |
| external_id | No | When true, treats unitId as an external ID instead of the internal Schoox ID. Default: false. Used with get action. |