users
Search and retrieve user profiles and badges from Schoox. Get identity data like name, email, role, and organizational placement.
Instructions
Look up Schoox user profiles and badges. Use this for identity data (name, email, role, organizational placement). For training progress, course completions, and analytics, use the dashboard tool instead.
Sub-actions:
list: Search and filter users by role, org unit, job, or search term. Paginated.
get: Get full profile for one user. Requires userId. Accepts Schoox ID, external ID (set external_id=true), or email (set is_email=true).
get_badges: List badges earned by a user. Requires userId.
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 user search, 'get' for one user's profile, 'get_badges' for earned badges | |
| userId | No | User identifier (e.g. 12345). Required for: get, get_badges. Accepts Schoox user ID, external ID (set external_id=true), or email (set is_email=true). | |
| external_id | No | When true, treats userId as an external system ID instead of Schoox internal ID. Default: false. | |
| is_email | No | When true, treats userId as an email address for lookup. Default: false. | |
| role | No | Filter by user role: employee, customer, instructor, or member. Used with list. | |
| past | No | Include past/terminated employees. Only applies when role=employee. Default: false. | |
| search | No | Search by first name, last name, email, or username. Used with list. | |
| aboveId | No | Filter by Above Unit ID (e.g. region/division). Used with list. | |
| unitId | No | Filter by Unit ID (e.g. store/location). Used with list. | |
| jobId | No | Filter by Job ID. Used with list. | |
| start | No | Starting position for pagination (e.g. 0). Used with list. | |
| limit | No | Max users per page, up to 1000. Default: 100. Used with list. |