Loading
API reference · Ligarbo BFF
Routes Ligarbo handles directly. Cohort-service APIs (contacts, segments, campaigns, etc.) are proxied through /api/v1/* and documented in their owning repos. The OpenAPI 3.1 spec for this surface lives in apps/ligarbo/docs/architecture/openapi.yaml.
| Method | Path | Auth | Description |
|---|---|---|---|
| GET | /api/healthz | Public | Liveness + readiness probe. Returns {status: ok, version}. |
| GET | /api/auth/me | Session cookie | Current session (delegated to Falcon-ID SDK). |
| POST | /api/auth/logout | Session cookie | Clears session + Falcon end-session. |
| POST | /api/auth/refresh | Session cookie | Server-side refresh-token rotation. |
| GET | /api/quota/usage | Session cookie | Current tenant quota usage (view-model wrapping the cohort summary). |
| POST | /api/quota/check | Session cookie | Preflight a quota consumption with {resource, amount}. |
| GET | /api/social/connect/{platform} | Session cookie | Initiate OAuth dance with a social platform (currently linkedin). |
| POST | /api/social/callback/{platform} | Session cookie | Finalize OAuth callback (state verify + code exchange). |
| POST | /api/v1/leads/ingest | API key | Public lead-ingest webhook (ADR 0008). Accepts contact payloads from any source. |
| GET | /api/v1/* | Session cookie | Catch-all proxy to platform cohort services (allow-listed prefixes only). |
The one public-facing write endpoint Ligarbo ships in v1. Accepts contact payloads from any source (Typeform, your own HTML form, LinkedIn lead-gen forwarder, etc.) authenticated by a Falcon-ID-issued tenant API key with the leads:ingest scope.
See ADR 0008 — lead-ingest-no-forms-builder. Form builders are a future sibling product (CMS-as-product), not Ligarbo's responsibility.
Session cookies are issued by Falcon-ID after the YouTube/Xbox SSO flow (ADR 0026). State-changing requests must include the X-CSRF-Token header — the BFF proxy enforces a timing-safe double-submit check.
Machine-readable spec lives in the repo · This page maintained by hand in sync with the OpenAPI YAML
