For the complete documentation index, see llms.txt. This page is also available as Markdown.

Task Data by Season

Overview

The Tasks API provides access to employee scheduled task assignments from flaik. Use this to synchronise scheduled teaching assignments with external data warehouse, workforce management, or labour planning systems.

Two endpoints are available — use the right one for your use case:

  • Full pullGET /api/schedule/tasks/{seasonId} — initial load or complete re-sync of all active assignments for a season

  • Delta pullGET /api/schedule/tasks/{seasonId}/delta — incremental sync of changes since a given timestamp

Results are returned in pages of up to 1,000 records. The response wrapper includes ready-made cursor values so clients can loop through pages without inspecting individual records.

See also: Pagination and Delta Sync — shared cursor pattern, tombstone semantics, recovery rules, and common pitfalls. The cursor mechanics described in that page apply to this endpoint pair.

Authentication

All Schedule endpoints require authentication. Include your access token in the Authorization header:

Authorization: Bearer {access_token}

See the Authentication Guide for details on obtaining access tokens.

Endpoints

Full Pull — Get All Tasks by Season

Retrieves all active employee scheduled task assignments for a season. Results are paginated — continue calling until hasMore is false.

Path Parameters

Parameter
Type
Required
Description

seasonId

integer

Yes

Season identifier — retrieve from GlobalSettings API

Query Parameters

Parameter
Type
Required
Description

nextAfterId

integer

No

Pagination cursor — pass the nextAfterId value from the previous response to retrieve the next page

pageSize

integer

No

Number of records per page. Maximum and default: 1000

Example Request — First Page

Example Request — Subsequent Page

Response Format

Response Wrapper Fields

Field
Type
Description

data

array

Page of task assignment records (see field descriptions below)

hasMore

boolean

true if further pages exist. Continue requesting until this is false

pageSize

integer

The page size applied to this response

nextAfterId

integer

Pass as nextAfterId on the next request to retrieve the next page. null when hasMore is false

Full pull results exclude soft-deleted records (deleted: true). Use the delta endpoint to receive deletions.


Delta Pull — Get Changed Tasks by Season

Retrieves task assignments that have been created, updated, or deleted since a given UTC timestamp. Use this for ongoing incremental sync after an initial full pull.

Path Parameters

Parameter
Type
Required
Description

seasonId

integer

Yes

Season identifier — retrieve from GlobalSettings API

Query Parameters

Parameter
Type
Required
Description

updatedAfterUtcDateTime

datetime

Yes

Only return tasks updated after this UTC timestamp (ISO 8601: YYYY-MM-DDTHH:mm:ssZ)

nextAfterId

integer

No

Pagination cursor — pass the nextAfterId value from the previous response to retrieve the next page

pageSize

integer

No

Number of records per page. Maximum and default: 1000

Example Request — First Delta Page

Example Request — Subsequent Delta Page

Response Format

Response Wrapper Fields

Field
Type
Description

data

array

Page of task assignment records, including soft-deleted records

hasMore

boolean

true if further pages exist. Continue requesting until this is false

pageSize

integer

The page size applied to this response

nextAfterId

integer

Pass as nextAfterId on the next request. null when hasMore is false

nextUpdatedAfterUtcDateTime

datetime

Pass as updatedAfterUtcDateTime on the next request when paginating a large delta result. Only populated when hasMore is true — you must pass both this and nextAfterId together to avoid missing or duplicating records at a timestamp boundary


Task Record Fields

Field
Type
Description

taskAssignmentId

integer

Unique task assignment identifier

employeeId

integer

Flaik employee identifier

payrollIdentifier

string

Employee identifier in your payroll system

posIdentifier

string

Employee identifier in your POS system

taskId

integer

Scheduling product (task definition) identifier

assignmentName

string

Display name of the task assignment

taskType

string

Type of task — see Task Types below

scheduledDate

date

Date the task is scheduled (YYYY-MM-DD)

startTime

time

Scheduled start time (HH:mm:ss)

endTime

time

Calculated end time (HH:mm:ss) based on start time and duration

comment

string

Optional comment on the assignment (nullable)

abilityLevelId

integer

Ability level identifier (nullable)

abilityLevelName

string

Ability level display name — empty string if not set

resortLocationId

integer

Resort location identifier (nullable)

resortLocationName

string

Resort location display name — empty string if not set

isInConflict

boolean

true if this assignment has a scheduling conflict

conflictCreatedByScopeWorkId

integer

Identifier of the scope of work that created the conflict (nullable)

associatedClassManagementClassId

integer

Associated class management class identifier (nullable)

sequenceOrderingNumber

string

Position of this task within a multi-task sequence (nullable)

updatedUtc

datetime

Last updated timestamp (UTC)

deleted

boolean

true if the assignment has been soft-deleted. Delta pull only — full pull never returns deleted records

disciplineCode

integer

Discipline identifier (nullable)

disciplineDescription

string

Discipline display name — empty string if not set

disciplinePosId

string

Discipline POS code — empty string if not set

Task Types

The taskType field will contain one of the following string values:

Value
Description

PrivateLesson

Private lesson assignment

GroupLesson

Group lesson assignment

ProgramLesson

Program/camp lesson assignment

Meeting

Staff meeting

Training

Staff training session

Other

Other scheduled task

Pagination

Both endpoints use the same cursor pattern documented in Pagination and Delta Sync.

Quick reference for tasks:

Soft-deleted task assignments appear only on the delta pull (deleted: true); use them to tombstone removed assignments in your store.

Error Responses

HTTP Status
Endpoint
Description

400

Both

The supplied seasonId does not exist for this resort

400

Delta only

updatedAfterUtcDateTime was not provided

401

Both

Missing or invalid access token

Need help with task data integration? Contact resortsupport@flaik.com.

Last updated

Was this helpful?