Skip to main content
All paths in this section are relative to:
Every request needs Authorization: Bearer fe_k_<your_key> (or an OAuth bearer if you’re using a partner connector).

Connection check

GET /me — verify a bearer is valid and inspect its scopes.

Leads

Create, read, update, delete, search leads. Notes, communications, commercial follow-up, enrichment.

Lead sources

Catalog of valid source values for dropdowns.

Pipeline stages

Read the organization’s pipeline configuration.

Projects

Manage your real-estate catalog at the project level.

Units

Individual units within a project. Status: available / reserved / sold.

Members

List the people in your FlowEstate organization.

Round robin

Auto-assign inbound leads across a team. Pools and assignment history.

Calendar

Read a member’s timezone and events. Create, update, delete events.

Sequences

Build, launch, pause, and resume cold-outreach sequences.

WhatsApp

List connected sender accounts and send one-off WhatsApp messages.

Webhooks

Manage event subscriptions. For payload format see the Webhooks guide.

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.
  • Errors share a single envelope. See Errors.
  • Lists are paginated unless they’re catalogs. See Pagination.