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

3. flaik Connect API

Flaik Connect is the integration API for the Flaik resort management platform. Resort IT teams and integration partners use it to sync schedules, classes, POS mappings, employee records, and timekeeping between Flaik and their other systems — data warehouses, payroll, BI, customer-experience platforms.

This section is the technical reference. Every endpoint is documented under one of the groups below.

New here? Start with these

  1. Overview — what Flaik Connect is, who it's for, how it works.

  2. Authentication — how to obtain and use access tokens (OAuth 2.0 client-credentials).

  3. Quick Start — five-minute walkthrough from credentials to your first real call.

Building anything that paginates schedule data? Read Pagination and Delta Sync before writing the loop.

Endpoint reference

Group
What it provides

Resort identity, seasons, guest survey definitions

Employee shifts and instructor task assignments. Full-pull and delta-pull routes for incremental sync.

Class details (instructors, guests, locations) and guest survey responses, by date range

POS product → Flaik task mappings for the season

Async upsert of employee data into Flaik and the resort's POS, plus a status-polling endpoint

Paid-activity timesheet rows with calculated wages and commissions

At a glance

  • REST over HTTPS, JSON in and out. OAuth 2.0 client-credentials with bearer JWTs (1-hour lifetime).

  • Server-to-server only. No CORS; don't call from a browser.

  • One credential pair per resort. Tokens are bound to a tenant — you don't pass a resort identifier on requests.

  • Read-heavy by design. The only write endpoint is Upsert Employee, which is async + queued.

  • No rate limiting today — but cache predictable responses (Resort Details, Seasons) and avoid tight loops.

Need help?

Contact resortsupport@flaik.com with your resort name, client_id, the endpoint URL, the request payload (redact secrets), the response status and body, and an approximate timestamp. That set of detail lets us trace the exact request in our logs.

Last updated

Was this helpful?