API Reference

The FluxCascade API allows you to programmatically manage connections, mappings, and sync jobs. All endpoints return JSON and require API key authentication.

Authentication

All API requests require authentication using an API key. You can create and manage API keys from your API Keys settings page.

Include your API key in requests using one of these methods:

Authorization Header (Recommended)

Authorization: Bearer YOUR_API_KEY

X-API-Key Header

X-API-Key: YOUR_API_KEY

Rate Limiting

The API enforces rate limits of 100 requests per minute per API key. Rate limit information is included in response headers:

Header	Description
X-RateLimit-Limit	Maximum requests per window (100)
X-RateLimit-Remaining	Requests remaining in current window
X-RateLimit-Reset	Unix timestamp when the window resets

API Scopes

API keys can be assigned different permission scopes:

read

Read-only access to connections, mappings, and sync history

write

Create and modify mappings, trigger syncs

admin

Full access including deletion and API key management

All Endpoints

Browse all available API endpoints below. Click on any endpoint to expand details, view request/response schemas, and see example code.

API Reference

The FluxCascade API allows you to programmatically manage connections, mappings, and sync jobs. All endpoints return JSON and require API key authentication.

Connections

Manage connected services and OAuth integrations

GET /connectionsGET /connections/:idGET /connections/providers

Mappings

Field mapping configurations between systems

GET /mappingsPOST /mappingsGET /mappings/:id+2 more

Syncs

Sync job execution and monitoring

GET /syncsPOST /syncsGET /syncs/:id+2 more

Webhooks

Event subscriptions and webhook management

GET /webhooks/event-typesPOST /webhooks/endpointsGET /webhooks/deliveries