Skip to content

REST API v1 · Resource

API description

The OpenAPI 3.1 document describing every endpoint and webhook event.

API reference · API description

Endpoints

Paths are relative to https://fliok.com/api/v1. Each endpoint names the scope and the lowest key role it needs; a key without them gets 403 (see Authentication).

The whole list is also an OpenAPI 3.1 document at /api/v1/openapi.json (no key needed): every endpoint with its scope, lowest role and request body, and every webhook event — import it into Postman, an SDK generator or an AI agent (or connect an AI app through Fliok's MCP server). Two things stay in the dashboard on purpose: connecting an integration (a browser sign-in with the other service — GET /integrations gives each one's connectUrl) and anything that moves money (plan, top-ups, payment methods).

API description

1
  • GET/openapi.jsonThis API as an OpenAPI 3.1 document: every endpoint with its scope and lowest role, request bodies, and the webhook events. No key neededNo key needed

Rate limits

These endpoints have no row of their own in the rate-limit table.

Every limit, the RateLimit-* headers and what to do on a 429: Rate limits.