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

# Listar Leads

> Retorna a lista de leads da conta autenticada, com suporte a filtros.



## OpenAPI

````yaml /api-reference/openapi.json get /lead
openapi: 3.0.3
info:
  title: WavUps CRM API
  description: >-
    API pública da plataforma WavUps CRM — gerencie leads, produtos, categorias,
    atendimentos, agendamentos, conversas e pipelines de CRM.
  version: 1.0.0
servers:
  - url: https://crm.wavups.com/api/v1
    description: Servidor de produção
security:
  - Token: []
paths:
  /lead:
    get:
      tags:
        - Leads
      summary: Listar Leads
      description: Retorna a lista de leads da conta autenticada, com suporte a filtros.
      operationId: listLeads
      parameters:
        - name: startDate
          in: query
          description: >-
            Data de início para filtrar leads pelo campo createdAt (ISO 8601,
            ex: 2025-01-01T00:00:00Z).
          schema:
            type: string
            format: date-time
        - name: endDate
          in: query
          description: >-
            Data de fim para filtrar leads pelo campo createdAt (ISO 8601, ex:
            2025-12-31T23:59:59Z).
          schema:
            type: string
            format: date-time
        - name: temperature
          in: query
          description: 'Filtra leads pela temperatura: 1 (Frio), 2 (Morno) ou 3 (Quente).'
          schema:
            type: integer
            enum:
              - 1
              - 2
              - 3
        - name: source
          in: query
          description: 'Filtra leads pela origem (ex: site, instagram, indicacao).'
          schema:
            type: string
        - name: phone
          in: query
          description: Filtra leads por número de telefone exato.
          schema:
            type: string
        - name: taxId
          in: query
          description: Filtra leads por número de CPF ou CNPJ exato.
          schema:
            type: string
        - name: leadOwner
          in: query
          description: Filtra leads pelo ID do usuário responsável.
          schema:
            type: string
        - name: leadType
          in: query
          description: 'Filtra leads pelo tipo (ex: PF, PJ).'
          schema:
            type: string
        - name: labelId
          in: query
          description: Filtra leads que possuem a etiqueta com o ID informado.
          schema:
            type: string
      responses:
        '200':
          description: Lista de leads retornada com sucesso.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Lead'
        '500':
          $ref: '#/components/responses/Error500'
components:
  schemas:
    Lead:
      type: object
      properties:
        id:
          type: string
        leadOwner:
          type: string
          nullable: true
        name:
          type: string
        email:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
          description: >-
            Telefone no formato 5547999999999 (pais + DDD + numero, sem espacos
            ou simbolos).
          example: '5547999999999'
        taxId:
          type: string
          nullable: true
          description: CPF ou CNPJ do lead.
          example: '12345678909'
        source:
          type: string
          nullable: true
        profileImage:
          type: string
          nullable: true
        zipCode:
          type: string
          nullable: true
        state:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        neighborhood:
          type: string
          nullable: true
        streetAddress:
          type: string
          nullable: true
        number:
          type: string
          nullable: true
        complement:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        leadType:
          type: string
          nullable: true
        leadTemperature:
          type: number
          nullable: true
          description: 'Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).'
        status:
          type: string
        metadata:
          type: object
          description: Metadados adicionais do lead em formato JSON.
          nullable: true
        utms:
          type: object
          description: Parâmetros UTM associados ao lead em formato JSON.
          nullable: true
          properties:
            utm_source:
              type: string
              description: 'Origem do tráfego (ex: fb, google, instagram).'
              example: fb
            utm_medium:
              type: string
              description: 'Meio do tráfego (ex: paid, cpc, organic, story).'
              example: paid
            utm_campaign:
              type: string
              description: Identificador ou nome da campanha.
              example: '120243645529690704'
            utm_term:
              type: string
              description: Termo de pesquisa ou identificador de público/anúncio.
              example: '120243645529720704'
            utm_content:
              type: string
              description: Conteúdo do anúncio ou identificador do criativo.
              example: '120247590343130704'
        createdAt:
          type: string
          format: date-time
    ErrorMessage:
      type: object
      properties:
        error:
          type: string
          example: Recurso não encontrado.
  responses:
    Error500:
      description: Erro interno no servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
  securitySchemes:
    Token:
      type: apiKey
      in: header
      name: Token
      description: Token de autenticacao gerado na plataforma WavUps CRM.

````