Pipelines & stages

Use this endpoint to discover the pipeline and stage IDs used when creating and moving leads, as well as the lost reasons.

Base URLhttps://app.syncro.chat/api/v1AuthX-API-Key: crm_SUA_CHAVE_AQUI

List pipelines and stages

GET/pipelines

Permission: pipelines:read

Returns all account pipelines with their stages (in order) and the list of lost reasons.

Request

curl "https://app.syncro.chat/api/v1/pipelines" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"

Response

{
  "success": true,
  "pipelines": [
    {
      "id": 1,
      "name": "Vendas",
      "stages": [
        {
          "id": 5,
          "name": "Prospecção",
          "color": "#FF6B6B",
          "is_won": false,
          "is_lost": false
        },
        {
          "id": 6,
          "name": "Proposta",
          "color": "#4ECDC4",
          "is_won": false,
          "is_lost": false
        },
        {
          "id": 10,
          "name": "Ganho",
          "color": "#95E1D3",
          "is_won": true,
          "is_lost": false
        },
        {
          "id": 11,
          "name": "Perdido",
          "color": "#9CA3AF",
          "is_won": false,
          "is_lost": true
        }
      ]
    }
  ],
  "lost_reasons": [
    {
      "id": 1,
      "name": "Preço alto"
    },
    {
      "id": 3,
      "name": "Escolheu concorrente"
    }
  ]
}

Stage fields

Field	Description
`is_won`	`true` on won stages (used in `PUT /leads/{id}/won`)
`is_lost`	`true` on lost stages (used in `PUT /leads/{id}/lost`)

The lost_reasons feed the reason_id parameter of PUT /leads/{id}/lost.