Funis

Um funil (pipeline) organiza negociações em estágios sequenciais (ex.: Prospecção → Negociação → Fechamento). Cada negociação pertence a um funil e está sempre em um dos estágios dele.

Não existe um endpoint dedicado a listar estágios isoladamente: os estágios de cada funil vêm embutidos na própria resposta do funil, no campo stages.

GET /api/pipelines
Authorization: Bearer elv_...

Listar funis#

GET /api/pipelines

Suporta a paginação padrão da API.

Resposta — `200`#

{
  "status": 200,
  "registersList": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "name": "Funil de Vendas",
      "description": "Funil principal",
      "stages": [
        {
          "_id": "507f1f77bcf86cd799439012",
          "name": "Prospecção",
          "order": 1,
          "default": true,
          "openValue": 15000
        },
        {
          "_id": "507f1f77bcf86cd799439013",
          "name": "Negociação",
          "order": 2,
          "default": false,
          "openValue": 8000
        }
      ],
      "openValue": 50000,
      "createdAt": "2025-07-18T14:15:13.321Z",
      "updatedAt": "2025-07-18T14:15:13.321Z"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 1,
    "totalItems": 1,
    "itemsPerPage": 10,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}

openValue é a soma do valor das negociações abertas — do funil inteiro no objeto raiz, e de cada estágio individualmente dentro de stages[].openValue.

O estágio com "default": true é o usado automaticamente quando uma negociação é criada sem stageId explícito.

Buscar funil por ID#

GET /api/pipelines/:pipelineId

Mesmo formato de objeto retornado em register, incluindo stages com os valores em aberto de cada estágio. Retorna 404 se o funil não existir para a empresa dona da API key.

{
  "status": 200,
  "register": { "_id": "507f1f77bcf86cd799439011", "name": "Funil de Vendas", "...": "..." }
}

Exemplo com curl#

curl -X GET "https://moveis-api.smarktech.app.br/api/pipelines" \
  -H "Authorization: Bearer $MODARI_API_KEY"

Erros comuns#