> ## 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.

# API Reference overview

> All endpoints, grouped by resource. Pick a topic to dive in.

All paths in this section are relative to:

```
https://panel.flowestate.app/api/v1
```

Every request needs `Authorization: Bearer fe_k_<your_key>` (or an OAuth bearer if you're using a partner connector).

<CardGroup cols={2}>
  <Card title="Connection check" icon="plug-circle-check" href="/api-reference/connection">
    `GET /me` — verify a bearer is valid and inspect its scopes.
  </Card>

  <Card title="Leads" icon="user-plus" href="/api-reference/leads">
    Create, read, update, delete, search leads. Notes and communications.
  </Card>

  <Card title="Lead sources" icon="tags" href="/api-reference/lead-sources">
    Catalog of valid `source` values for dropdowns.
  </Card>

  <Card title="Pipeline stages" icon="list-ol" href="/api-reference/pipeline">
    Read the organization's pipeline configuration.
  </Card>

  <Card title="Projects" icon="building" href="/api-reference/projects">
    Manage your real-estate catalog at the project level.
  </Card>

  <Card title="Units" icon="door-open" href="/api-reference/units">
    Individual units within a project. Status: available / reserved / sold.
  </Card>

  <Card title="Members" icon="users" href="/api-reference/members">
    List the people in your FlowEstate organization.
  </Card>

  <Card title="Round robin" icon="arrows-rotate" href="/api-reference/round-robin">
    Auto-assign inbound leads across a team. Pools and assignment history.
  </Card>

  <Card title="Calendar" icon="calendar" href="/api-reference/calendar">
    Read a member's timezone and events. Create, update, delete events.
  </Card>

  <Card title="Sequences" icon="tower-broadcast" href="/api-reference/sequences">
    Build, launch, pause, and resume cold-outreach sequences.
  </Card>

  <Card title="WhatsApp" icon="whatsapp" href="/api-reference/whatsapp">
    List connected sender accounts and send one-off WhatsApp messages.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/api-reference/webhooks">
    Manage event subscriptions. For payload format see the [Webhooks guide](/webhooks).
  </Card>
</CardGroup>

## Conventions

* Path parameters are wrapped in braces: `/leads/{leadId}`.
* Query parameters are listed in tables under each endpoint.
* Request bodies are JSON. Required vs optional is called out per field.
* All responses are JSON. See [Response format](/response-format).
* Errors share a single envelope. See [Errors](/errors).
* Lists are paginated unless they're catalogs. See [Pagination](/pagination).