Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.flowestate.app/llms.txt

Use this file to discover all available pages before exploring further.

Every API key carries a list of scopes. A request fails with 403 FORBIDDEN if the key is missing any required scope, with a message like:
Insufficient permissions. Missing scopes: leads:write

Available scopes

ScopeGrants
leads:readList, get, search leads. Read activities and pipeline stages.
leads:writeCreate, update, delete leads. Add notes and communications.
projects:readList and get projects and units.
projects:writeCreate, update, delete projects and units.
members:readList organization members.
pipeline:readRead pipeline stages (also covered by leads:read).
lead-sources:readRead the lead-source catalog (also covered by leads:read).
webhooks:manageList event types, create / list / delete webhook subscriptions.
Each endpoint section in the API Reference lists the exact scope it requires.

Choosing scopes

Common patterns:
  • Lead ingestion only (Meta Ads form, web form, landing page): leads:write.
  • Two-way sync (a CRM tool that needs to read and update leads): leads:read, leads:write.
  • BI / reporting (read-only dashboards): leads:read, projects:read, members:read.
  • Catalog publisher (sync units availability to a website): projects:read, projects:write.
  • Webhook orchestrator (Zapier, Make, n8n connectors): webhooks:manage plus the read/write scopes you actually use.
You can edit a key’s scopes in the dashboard at any time. Changes take effect on the next request.