> For the complete documentation index, see [llms.txt](https://knowledgebase.flaik.com/flaik-knowledge-base/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api.md).

# 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**](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/overview) — what Flaik Connect is, who it's for, how it works.
2. [**Authentication**](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/overview/authentication) — how to obtain and use access tokens (OAuth 2.0 client-credentials).
3. [**Quick Start**](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/overview/quick-start) — five-minute walkthrough from credentials to your first real call.

Building anything that paginates schedule data? Read [**Pagination and Delta Sync**](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/overview/pagination-and-delta-sync) before writing the loop.

### Endpoint reference

| Group                                                                                                                                   | What it provides                                                                                       |
| --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| [Global Settings](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/global-settings)         | Resort identity, seasons, guest survey definitions                                                     |
| [Schedule](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/schedule)                       | Employee shifts and instructor task assignments. Full-pull and delta-pull routes for incremental sync. |
| [Class Management](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/class-management)       | Class details (instructors, guests, locations) and guest survey responses, by date range               |
| [POS Integration](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/pos-integration)         | POS product → Flaik task mappings for the season                                                       |
| [Employee Management](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/employee-management) | Async upsert of employee data into Flaik and the resort's POS, plus a status-polling endpoint          |
| [Timekeeping](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/timekeeping)                 | 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](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/employee-management/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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.