List lessons
teachworks_list_lessonsRead-only
List lessons (the calendar) with teacher, service, location, start/end, duration, status and participants. Filter by teacher, student, location, service, status and date range. GET /lessons.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Search by lesson name. | |
| page | No | Page number (1-based, default 1). | |
| status | No | ||
| date_to | No | Lessons starting on or before this date. | |
| joinable | No | true = only lessons marked joinable. | |
| per_page | No | Records per page (default 20, max 50). | |
| date_from | No | Lessons starting on or after this date. | |
| direction | No | Sort by id ascending (default) or descending (newest first). | |
| from_date | No | Lessons starting on exactly this date. | |
| series_id | No | Only lessons of this repeating series. | |
| service_id | No | Only lessons of this service. | |
| student_id | No | Only lessons with this student. | |
| employee_id | No | Only lessons taught by this teacher (employee id). | |
| location_id | No | Only lessons at this location (exact). | |
| custom_status | No | Search by custom status (Custom Statuses add-on). | |
| include_deleted | No | true = include deleted lessons. | |
| location_or_parent_location_id | No | Lessons at this location or any of its sub-locations. |