Reference

Build on Float

API keys, webhooks and a read API — the developer surface is part of the Scale plan. Manage it under Settings → Developer tools.

Scale feature

API keys, webhooks, and the audit log live on Scale. On Grow the Developer tools panel shows a locked teaser that links to the Plan page.

API keys

Create keys under Settings → Developer tools. The full secret (prefixed float_sk_) is shown once at creation — copy it then; Float only ever stores a SHA-256 hash. Authenticate with a bearer token:

curl https://<your-float-host>/api/v1/summary \
  -H "Authorization: Bearer float_sk_..."

Read API

GET /api/v1/summary

Forecast summary — operating cash, next crunch, receivables and health score.

GET /api/v1/invoices

Invoices with status, amounts and predicted payment dates.

A summary response looks like this — everything you need to drop your runway into a dashboard or trigger an internal alert:

{
  "currency": "AED",
  "operating_cash": 30000,
  "safety_buffer": 6000,
  "crunch": { "day": 43, "date": "2026-08-21", "balance": 2932 },
  "receivables": { "outstanding": 38450, "overdue": 3150 },
  "health_score": 62
}

Webhooks

Register endpoints under Settings → Developer tools and subscribe to events. Every delivery is signed with an HMAC-SHA256 X-Float-Signature header — verify it against your endpoint secret.

invoice.paid

An invoice was marked paid.

invoice.chased

A chase was sent to a client.

bridge.accepted

A financing bridge was accepted.

crunch.detected

A cash crunch entered the forecast.

Integrations

Beyond the API, Float connects to accounting, tax, payments, payroll, commerce and expenses apps per edition (Xero, QuickBooks, Stripe, Shopify, HMRC MTD / FTA, WPS, and more). Connections only report “connected” after a real sync — no fake states.

Architecture & self-hosting

Running or extending Float itself? The engineering reference — stack, the forecast engine, data model, provider interfaces, auth, billing, jobs, testing and env — lives in docs/ARCHITECTURE.md in the repository, alongside the ADRs in docs/adr/.

Wire Float into your stack

Pull your forecast into dashboards, trigger workflows on crunch detection, and automate chasing — all on Scale.

See Scale Get started

Was this page helpful?

PreviousSecurity & privacy NextFAQ