curriculums
Query structured training programs (learning paths) to retrieve metadata, enrollments, and student lists, with pagination and filters.
Instructions
Query learning paths (curricula) — collections of courses that form a structured training program. Use this for learning path metadata, enrollment, and student lists. For a user's completion progress across learning paths, use the dashboard tool with get_user_curriculums action.
Sub-actions:
list: Search and filter learning paths. Paginated.
list_user_curriculums: List learning paths for a specific user. Requires userId. Paginated.
get: Get full details of a single learning path. Requires curriculumId.
get_students: List students enrolled in a learning path. Requires curriculumId. Paginated.
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 catalog, 'get' for details, 'list_user_curriculums' for a user's paths, 'get_students' for enrollees | |
| start | No | Starting position for pagination (e.g. 0). Used with list, list_user_curriculums, get_students. | |
| limit | No | Max results per page. Used with list, list_user_curriculums, get_students. | |
| status | No | Learning path status: active or archived. Default: active. Used with list. | |
| external_id | No | When true, treats userId as an external system ID instead of Schoox internal ID. Default: false. Used with list_user_curriculums. | |
| userId | No | User ID. Required for: list_user_curriculums. Set external_id=true if passing an external ID. | |
| anyLanguage | No | When true, returns all courses regardless of language. Default: false. Used with list_user_curriculums. | |
| curriculumId | No | Learning path ID (e.g. 5001). Required for: get, get_students. | |
| onlyCompleted | No | When true, returns only users who completed the path. Used with get_students. | |
| completionStartDate | No | ISO date string (e.g. 2024-01-01). Returns users who completed after this date. Used with get_students. | |
| completionEndDate | No | ISO date string (e.g. 2024-12-31). Returns users who completed before this date. Used with get_students. |