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.

These are the canonical values for the enum-like fields on FlowEstate resources. Where indicated, custom strings are also accepted; everything else must be one of the listed values exactly (case-sensitive).

​
LeadStatus

new, contacted, qualified, proposal, negotiation, won, lost The lifecycle stages of a lead. Custom pipeline stages live separately on stageId (see /pipeline/stages).

​
LeadSource

website, referral, social_media, advertising, bot_cold_outreach, cold_call, email, event, meta, landing_page, whatsapp, other
Custom strings are accepted. When you send an unknown value on POST /leads, it’s stored as other on the enum column and the original string is preserved in sourceMetadata.providedSource. This lets you keep your own UTM mapping (e.g. "google_ads_lookalike_q3") without losing the value.

​
LeadTemperature

cold, warm, hot

​
LeadActivityType

created, status_changed, field_updated, assigned, unassigned, synced, note, call, email, meeting, social_message System-generated activities are typed as created, status_changed, field_updated, assigned, unassigned, synced. The rest (note, call, email, meeting, social_message) are produced by users or by the API endpoints POST /leads/{id}/notes and POST /leads/{id}/communications.

​
CommunicationDirection

inbound, outbound Used together with type on POST /leads/{id}/communications.

​
WebhookEventType

Lead events: lead.created, lead.updated, lead.stage_changed, lead.assigned, lead.unassigned, lead.won, lead.lost, lead.deleted, lead.note_added, lead.communication_logged Project events: project.created, project.updated, project.deleted Unit events: unit.created, unit.updated, unit.status_changed You can also retrieve this list at runtime from GET /webhooks/events — useful for dynamic dropdowns.

​
Project status

draft, published, archived draft projects are visible only inside the dashboard. published projects can be exposed externally. archived projects are hidden but recoverable.

​
Unit status

available, reserved, sold A unit.status_changed webhook fires whenever this changes via the API.

​
LeadActivityScope

lead_event (default), and reserved values for future system scopes. The activityScope filter on GET /leads/{id}/activities defaults to lead_event, which is what’s normally relevant to integrations.