> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useintegra.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar funis

> Os funis de venda da organização, com as etapas na ordem

Use os ids dos funis e das etapas para [criar](https://docs.useintegra.com.br/api-reference/endpoint/crm-create-deal.md) e [mover](https://docs.useintegra.com.br/api-reference/endpoint/crm-update-deal.md) negócios.

> [!NOTE]
>
> As rotas do CRM pedem o CRM ligado na organização. Com ele desligado, a resposta é `409`. Ligue no painel, em **CRM > Configurações**.


## OpenAPI

````yaml GET /api/v1/crm/pipelines
openapi: 3.1.0
info:
  title: Integra BFI API
  version: 1.0.0
  description: >
    <img src="/public/logo_dark.webp" alt="Integra" height="36"
    style="margin-bottom:16px" />


    A API da Integra para integrações externas.


    > [!tip]

    > **Copie a documentação completa para sua IA favorita:**

    > [Abrir página de cópia](/docs/markdown) ou baixe o [llm.txt](/llm.txt)


    ---


    ## Como começar


    ### 1. Gerar sua API Key


    Acesse o painel da Integra em **Settings > API Keys** e clique em **Nova API
    Key**.


    > [!important]

    > Copie a key gerada (`ik_live_...`) imediatamente: ela **só será exibida
    uma vez**.


    ### 2. Autenticar requests


    Envie o header `Authorization` em todas as chamadas:


    ```

    Authorization: Bearer ik_live_sua_key_aqui

    ```


    ### 3. Fazer sua primeira chamada


    ```bash

    curl -H "Authorization: Bearer ik_live_xxx" \
      https://api.useintegra.com.br/api/v1/campaigns
    ```


    > [!success]

    > Se a resposta for `200 OK` com JSON, sua integração está funcionando!


    ---


    ## Rate Limiting


    | Header | Descrição |

    |--------|-----------|

    | `X-RateLimit-Limit` | Limite total (60/min) |

    | `X-RateLimit-Remaining` | Requests restantes |

    | `X-RateLimit-Reset` | Timestamp de reset (epoch) |


    > [!warning]

    > Ao exceder **60 requests/minuto** por API Key, a API retorna status `429
    Too Many Requests`.


    ---


    ## Erros comuns


    | Status | Erro | Causa |

    |--------|------|-------|

    | `401` | Invalid API key | Key inválida ou revogada |

    | `403` | Forbidden | Key sem permissão para o recurso |

    | `429` | Rate limit exceeded | Excedeu 60 req/min |

    | `500` | Internal server error | Erro interno, contate o suporte |
servers:
  - url: https://api.useintegra.com.br
    description: Production
security:
  - ApiKey: []
tags:
  - name: Campaigns
    description: Gerenciamento de campanhas de voz e WhatsApp
  - name: Calls
    description: Histórico de chamadas
  - name: CRM
    description: 'CRM Integra da organização: funis, contatos, negócios e atividades'
  - name: Automations
    description: Dispara as automações com o gatilho Chamada pela nossa API
  - name: Meetings
    description: Reuniões que os agentes marcaram na agenda da organização
  - name: Webhooks
    description: Gerenciamento de webhooks para notificações em tempo real
paths:
  /api/v1/crm/pipelines:
    get:
      tags:
        - CRM
      summary: Listar funis com as etapas
      responses:
        '200':
          description: >-
            Todos os funis da organização (os arquivados com archived_at), na
            ordem, com as etapas na ordem
          content:
            application/json:
              schema:
                type: object
                properties:
                  pipelines:
                    type: array
                    items:
                      $ref: '#/components/schemas/CrmPipeline'
                required:
                  - pipelines
        '401':
          description: Não autenticado
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '403':
          description: A chave não tem o escopo crm:read
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '409':
          description: >-
            O CRM está desligado na organização (ligue no painel, em CRM >
            Configurações)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
      security:
        - ApiKey: []
components:
  schemas:
    CrmPipeline:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        is_default:
          type: boolean
          description: 'O funil padrão: recebe o negócio criado sem pipeline_id nem stage_id'
        position:
          type: number
        archived_at:
          type:
            - string
            - 'null'
          description: Quando foi arquivado (não recebe negócio); null no ativo
          example: '2026-11-02T14:00:00.000Z'
        stages:
          type: array
          items:
            $ref: '#/components/schemas/CrmStage'
        created_at:
          type: string
          description: Criação (UTC)
          example: '2026-11-02T14:00:00.000Z'
        updated_at:
          type: string
          description: Última mudança (UTC)
          example: '2026-11-02T14:00:00.000Z'
      required:
        - id
        - name
        - is_default
        - position
        - archived_at
        - stages
        - created_at
        - updated_at
    CrmStage:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        position:
          type: number
        kind:
          type: string
          enum:
            - open
            - won
            - lost
          description: >-
            open (aberta), won (ganho) ou lost (perdido): o negócio na etapa
            fica com esse status
        probability:
          type:
            - number
            - 'null'
      required:
        - id
        - name
        - position
        - kind
        - probability
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'API Key da organização (Authorization: Bearer ik_live_xxx)'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.