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

Quick Start

This is the shortest path from "credentials in hand" to "I made a real call". Five minutes if your network and credentials are good.

What you need before starting

  1. A client_id and client_secret issued by flaik. Don't have one? Contact resortsupport@flaik.com.

  2. The API base URL Flaik gave you for your environment (something like https://api.flaik.com).

  3. A way to make HTTPS requests — curl, Postman, your language's HTTP client, etc.

Step 1 — Fetch an access token

Send client_credentials to the token endpoint with the read scope:

curl -X POST https://auth-usw2.flaik.com/connect/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET" \
  -d "scope=flaik.connect.api.read"

Expected response:

{
  "access_token": "eyJhbGciOiJSUzI1NiIs…",
  "expires_in": 3600,
  "token_type": "Bearer",
  "scope": "flaik.connect.api.read"
}

Copy the access_token value — you'll use it on every subsequent call.

Token expires after 1 hour. Cache and reuse it; fetch a new one when it's about to expire. See Authentication → Token Caching for the recommended pattern.

Step 2 — Confirm your tenant

Hit the resort details endpoint to confirm the token resolves to the resort you expect:

Expected response (truncated):

If the name and location match your resort — auth is wired up correctly. If you see a different resort, double-check the credentials. If you get a 401, the token is missing or invalid; fetch a new one.

See the full response shape on the Resort Details page.

Step 3 — List the resort's seasons

Most other endpoints take a seasonId. Get the list of available seasons next:

Expected response (truncated):

The season with "isCurrent": true is the one happening now. Note the id — you'll pass it as {seasonId} on most other endpoints.

See the full response shape on the Seasons page.

Step 4 — Make a real data call

Use the season id from the previous step to fetch employee shifts for the current season:

Expected response shape:

If hasMore is true, there are more pages. See Pagination and Delta Sync for the cursor pattern.

Where to go next

Once you've got a successful call, head to the endpoint you actually need:

Use case
Endpoint

Pull employee shifts

Pull instructor task assignments

Pull lesson/class details

Pull guest survey responses

Pull POS product → Flaik task mappings

Pull paid-activity timesheet rows

Push employee data into Flaik / POS

Troubleshooting

You see
Try

invalid_client from the token endpoint

Re-check client_id/client_secret. Whitespace and quote characters are common culprits when copying.

invalid_scope from the token endpoint

Your client isn't authorised for the scope you requested. Contact Flaik to confirm what's allowed.

401 Unauthorized from an API call

Token is missing, expired, or invalid. Fetch a fresh one and retry.

403 Forbidden from an API call

Token doesn't include the scope the endpoint needs (e.g. calling Upsert with a read-only token).

400 with "Season {id} does not exist…"

The seasonId isn't configured for your resort. Pull /api/globalsettings/seasons to see valid IDs.

See the Error Handling page for the full status-code map and retry guidance.

Need help getting started? Contact resortsupport@flaik.com.

Last updated

Was this helpful?