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.

Stages are the configurable columns of the lead board. Each organization defines its own; this endpoint lets you discover them at runtime so your integration can route leads to the right stage by name.

​
GET /pipeline/stages

Scope: leads:read. Lists the organization’s pipeline stages in display order.

​
Request

curl https://panel.flowestate.app/api/v1/pipeline/stages \
  -H "Authorization: Bearer fe_k_your_key_here"

​
Response 200

{
  "data": [
    {
      "id": "stage_...",
      "name": "New",
      "color": "#0ea5e9",
      "order": 0,
      "stageKind": "open",
      "systemKey": "new",
      "createdAt": "2025-10-01T12:00:00.000Z",
      "updatedAt": "2026-01-15T18:00:00.000Z"
    },
    {
      "id": "stage_...",
      "name": "Contacted",
      "color": "#a855f7",
      "order": 1,
      "stageKind": "open",
      "systemKey": "contacted",
      "createdAt": "2025-10-01T12:00:00.000Z",
      "updatedAt": "2025-10-01T12:00:00.000Z"
    }
  ]
}

​
Fields

FieldDescription
idUUID. Use this on POST /leads and PUT /leads/{id} as the stageId field.
nameDisplay name in the dashboard. May be localized or customized by the organization.
colorHex color used by the dashboard board.
orderDisplay order. Lower numbers come first.
stageKindLifecycle bucket: open, won, lost.
systemKeyOptional key matching one of the system stages (new, contacted, etc.). May be null for fully custom stages.
Use systemKey if you need to detect the canonical stage. Use id when you need to route a lead to a specific column.