Schedule
Employee schedule data — shifts and instructor task assignments — for syncing into data warehouses, payroll systems, workforce-management tools, and BI. The two endpoints in this group are the highest-volume use case for most Connect integrations.
Both endpoints follow the same paginated, dual-route pattern: a full pull for the initial load and a delta pull for ongoing incremental sync. Read Pagination and Delta Sync once before building either; the cursor mechanics are identical across both.
Pages in this group
Shift Data By Season — employee shifts (
GET /api/schedule/shifts/{seasonId}and…/delta). Use for payroll, labour planning, time-and-attendance.Task Data By Season — instructor task assignments (
GET /api/schedule/tasks/{seasonId}and…/delta). Use for teaching analytics, productivity reporting, instructor utilisation.
Typical sync pattern
Run the full pull once to seed your store.
Record the timestamp at which the full pull completed.
From then on, run the delta pull on a schedule (every few minutes for near-real-time, or hourly/nightly for batch), passing the timestamp of your last successful sync.
Apply soft-deleted records (
deleted: truefrom the delta pull) as tombstones in your store.
See the Pagination and Delta Sync page for the cursor pattern, recovery rules, and common pitfalls.
Last updated
Was this helpful?
