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.

​
1. Create an API key

  1. Sign in to your FlowEstate organization at panel.flowestate.app.
  2. Navigate to Settings → API Keys.
  3. Click New API key, give it a descriptive name (e.g. make-lead-ingest), and select the scopes you need. Most “send leads from a form” use cases only need leads:write.
  4. Copy the key — it starts with fe_k_.
    The full key is shown only once. If you lose it, revoke it and create a new one.

​
2. Test the key

The /me endpoint requires no scope and is the safest sanity check: 
curl https://panel.flowestate.app/api/v1/me \
  -H "Authorization: Bearer fe_k_your_key_here"
You should see your organization name and the scopes attached to the key: 
{
  "organization": { "id": "org_...", "name": "Acme Realty", "slug": "acme-realty" },
  "auth": { "type": "api_key", "scopes": ["leads:write"], "clientId": null, "userId": null }
}

​
3. Create your first lead

curl -X POST https://panel.flowestate.app/api/v1/leads \
  -H "Authorization: Bearer fe_k_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Ada",
    "lastName": "Lovelace",
    "email": "ada@example.com",
    "source": "website"
  }'
A 201 Created response with the new lead’s id means everything is wired correctly. Open the Leads view in your dashboard — Ada should be there.
At least one of email or phone is required. Empty strings are treated as missing. See Create a lead for the full payload.

​
4. Next steps