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

# Listar funis

> Lista todos os funis do escritório.



## OpenAPI

````yaml https://api.jurichat.com/docs/client/openapi.json get /funnel/
openapi: 3.1.0
info:
  title: JuriChat API — Documentação para Integradores
  description: ''
  version: 1.0.0
servers:
  - url: https://api.jurichat.com
    description: Production server
security:
  - apiKeyAuth: []
tags: []
paths:
  /funnel/:
    get:
      tags:
        - CRM
      summary: Listar funis
      description: Lista todos os funis do escritório.
      parameters:
        - schema:
            type: string
            pattern: ^[cC][^\s-]{8,}$
          in: query
          name: inboxId
          required: true
          description: ID da inbox.
        - schema:
            type: string
          in: query
          name: name
          required: false
          description: Filtra funis pelo nome.
        - schema:
            type: string
          in: query
          name: userId
          required: false
          description: Filtra funis pelo responsável.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    columns:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                          color:
                            type: string
                          index:
                            type: number
                          kind:
                            type: string
                            enum:
                              - NORMAL
                              - WON
                              - LOST
                        required:
                          - id
                          - name
                          - color
                          - index
                          - kind
                        additionalProperties: false
                    cardConfig:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            minLength: 1
                            maxLength: 200
                            description: >-
                              Identificador do campo. Campos personalizados usam
                              `customField:<id>`.
                          visible:
                            type: boolean
                            description: Indica se o campo é exibido no card.
                        required:
                          - id
                          - visible
                        additionalProperties: false
                      maxItems: 50
                      description: >-
                        Campos do card e sua ordem. `null` quando o funil usa o
                        padrão.
                      nullable: true
                    createdAt:
                      type: string
                      format: date-time
                    inboxId:
                      type: string
                      pattern: ^[cC][^\s-]{8,}$
                    updatedAt:
                      type: string
                      format: date-time
                  required:
                    - id
                    - name
                    - cardConfig
                    - createdAt
                    - inboxId
                    - updatedAt
                  additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  code:
                    type: string
                  details:
                    anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - type: object
                        properties: {}
                        additionalProperties: true
                    description: Detalhes adicionais do erro.
                required:
                  - message
                  - statusCode
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  code:
                    type: string
                  details:
                    anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - type: object
                        properties: {}
                        additionalProperties: true
                    description: Detalhes adicionais do erro.
                required:
                  - message
                  - statusCode
                additionalProperties: false
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-jurichat-api-key
      description: >-
        Chave de API do escritório (criada no painel). Envie o valor no header
        x-jurichat-api-key.

````