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

# Obtém informações do lead

> Retorna os detalhes completos de um lead, incluindo tags, coluna do kanban e metadados.



## OpenAPI

````yaml /api-reference/zattenapi.json get /leads/{leadNumber}
openapi: 3.1.0
info:
  title: API de Atendimento e Mensageria
  description: >-
    API para interagir com o sistema de atendimento, permitindo o envio de
    mensagens via template do WhatsApp e a gestão de informações de leads. A
    autenticação é realizada através de uma chave de API (`x-api-key`) enviada
    no cabeçalho de cada requisição. A API também possui um sistema de limite de
    requisições (rate limiting) para garantir a estabilidade.
  version: 1.0.0
servers:
  - url: https://api.zatten.com/api/v1
security:
  - ApiKeyAuth: []
tags:
  - name: Mensagens
    description: Endpoints para envio e consulta de mensagens.
  - name: Leads
    description: Endpoints para gerenciamento de dados de leads.
  - name: Kanban
    description: Endpoints para consulta de estruturas de organização do CRM.
  - name: Tags
    description: Endpoints para consulta de etiquetas (tags) de organização.
paths:
  /leads/{leadNumber}:
    get:
      tags:
        - Leads
      summary: Obtém informações do lead
      description: >-
        Retorna os detalhes completos de um lead, incluindo tags, coluna do
        kanban e metadados.
      parameters:
        - name: leadNumber
          in: path
          description: O número de WhatsApp (WaId) do lead.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Informações do lead retornadas com sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  lead:
                    $ref: '#/components/schemas/LeadInformation'
        '400':
          description: Erro de validação ou requisição inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Chave de API (`x-api-key`) ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Lead não encontrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Limite de requisições excedido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    LeadInformation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        phone:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: string
        annotation:
          type: string
        kanban_column:
          $ref: '#/components/schemas/KanbanColumnInfo'
        current_tags:
          type: array
          items:
            $ref: '#/components/schemas/TagInfo'
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Descrição do erro ocorrido.
    KanbanColumnInfo:
      type: object
      properties:
        name:
          type: string
        id:
          type: string
    TagInfo:
      type: object
      properties:
        name:
          type: string
        id:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Chave de API necessária para autenticar todas as requisições.

````