> 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/overview.md).

# Overview

### What is Flaik Connect?

Flaik Connect is the **integration API** for the Flaik resort management platform. It exposes a focused set of read and write endpoints that resort operators and their integration partners use to:

* Sync **schedules** (shifts and instructor task assignments) into data warehouses, payroll, and workforce-management systems.
* Pull **class** details and guest survey responses for reporting and customer-experience analytics.
* Read **POS product → Flaik task mappings** to translate point-of-sale activity into Flaik's domain.
* Read **paid-activity timesheet** data with calculated wage and commission figures for payroll export.
* Push **employee** records into Flaik and out to the resort's POS in one async call.
* Fetch shared **global settings** (resort identity, seasons, survey definitions) needed by the calls above.

### Who is this for?

* **Resort IT and integration partners** building point-to-point connections between Flaik and another system (data warehouse, payroll, BI, POS).
* **Reporting / analytics teams** pulling class, schedule, and timesheet data on a schedule.

### How it works

| Aspect           | Detail                                                                                                                                                                                                        |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Style            | REST over HTTPS, JSON request and response bodies                                                                                                                                                             |
| Authentication   | OAuth 2.0 client-credentials with bearer JWT tokens (1-hour lifetime)                                                                                                                                         |
| Scopes           | `flaik.connect.api.read`, `flaik.connect.api.write`, `flaik.connect.api.admin`                                                                                                                                |
| Tenant model     | Each `client_id` is permanently bound to one resort; you don't pass a tenant identifier on requests                                                                                                           |
| Versioning       | Single, current version. Breaking changes are rare and announced in advance to credentialed partners                                                                                                          |
| Pagination       | Cursor-based via response wrapper (`hasMore`, `nextAfterId`) on schedule endpoints; non-paginated elsewhere                                                                                                   |
| Incremental sync | Schedule endpoints offer paired `/full` and `/delta` routes; Timekeeping uses an `updatedAfterLocalDateTime` query                                                                                            |
| Errors           | HTTP status codes + JSON body. Most use RFC 7807 `ProblemDetails`; see [Error Handling](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/overview/error-handling) |

### Endpoint groups

| 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, 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                                  |

### Where to start

1. [**Authentication**](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/overview/authentication) — how to obtain and use access tokens.
2. [**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.
3. [**Pagination and Delta Sync**](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/overview/pagination-and-delta-sync) — read this before building any sync against the schedule endpoints.
4. [**Error Handling**](https://knowledgebase.flaik.com/flaik-knowledge-base/for-it-specialists/3.-flaik-connect-api/overview/error-handling) — status codes, response shapes, retry guidance.
5. The endpoint group that matches your use case (table above).

### Operational notes

* **No rate limiting today.** This will likely change; partners should aim to keep request volume reasonable (avoid tight loops, cache predictable responses like Resort Details and Seasons).
* **No CORS.** Connect is for server-to-server use. Don't call it directly from a browser.
* **No webhooks except the one on Upsert Employee.** All other ingestion is poll-based; design accordingly.
* **Production endpoint stability.** URLs and response contracts are stable; new fields may be added but existing ones won't be removed without notice.

### Support

Need credentials, scope changes, or have a question about a specific call? Contact <resortsupport@flaik.com> with:

* Your resort name and `client_id`
* The endpoint URL you called
* The request payload (redact secrets)
* The response status and body
* An approximate timestamp

That set of detail lets Flaik 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/overview.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.