> ## 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.

# Obter Lead

> Retorna os detalhes de um lead específico pelo ID.

## Requisição

<ParamField header="Token" type="string" required>
  Seu token de autenticação.
</ParamField>

### Path Parameters

<ParamField path="id" type="string" required>
  ID do lead a ser recuperado.
</ParamField>

***

## Resposta

Retorna o objeto completo do lead solicitado.

<ResponseField name="id" type="string">
  Identificador único do lead.
</ResponseField>

<ResponseField name="accountId" type="string">
  ID da conta à qual o lead pertence.
</ResponseField>

<ResponseField name="leadOwner" type="string | null">
  ID do usuário responsável pelo lead.
</ResponseField>

<ResponseField name="name" type="string">
  Nome do lead.
</ResponseField>

<ResponseField name="email" type="string | null">
  E-mail do lead.
</ResponseField>

<ResponseField name="phone" type="string | null">
  Telefone do lead.
</ResponseField>

<ResponseField name="taxId" type="string | null">
  CPF/CNPJ do lead.
</ResponseField>

<ResponseField name="source" type="string | null">
  Origem do lead.
</ResponseField>

<ResponseField name="profileImage" type="string | null">
  URL da imagem de perfil do lead.
</ResponseField>

<ResponseField name="zipCode" type="string | null">
  CEP do endereço do lead.
</ResponseField>

<ResponseField name="state" type="string | null">
  Estado do lead.
</ResponseField>

<ResponseField name="city" type="string | null">
  Cidade do lead.
</ResponseField>

<ResponseField name="neighborhood" type="string | null">
  Bairro do lead.
</ResponseField>

<ResponseField name="streetAddress" type="string | null">
  Logradouro do lead.
</ResponseField>

<ResponseField name="number" type="string | null">
  Número do endereço.
</ResponseField>

<ResponseField name="complement" type="string | null">
  Complemento do endereço.
</ResponseField>

<ResponseField name="description" type="string | null">
  Descrição ou observações sobre o lead.
</ResponseField>

<ResponseField name="leadType" type="string | null">
  Tipo do lead (ex: `PF`, `PJ`).
</ResponseField>

<ResponseField name="leadTemperature" type="number | null">
  Temperatura do lead: `1` (Frio), `2` (Morno) ou `3` (Quente).
</ResponseField>

<ResponseField name="metadata" type="object | null">
  Metadados adicionais do lead em formato JSON.
</ResponseField>

<ResponseField name="utms" type="object | null">
  Parâmetros UTM associados ao lead em formato JSON.
</ResponseField>

<ResponseField name="status" type="string">
  Status atual do lead.
</ResponseField>

<ResponseField name="createdAt" type="string">
  Data e horário de criação do lead (ISO 8601).
</ResponseField>

<ResponseField name="updatedAt" type="string">
  Data e horário da última atualização (ISO 8601).
</ResponseField>

***

## Exemplos

<RequestExample>
  ```bash GET /api/v1/lead/{id} theme={null}
  curl --request GET \
    --url 'https://crm.wavups.com/api/v1/lead/clxyz1234' \
    --header 'Token: SEU_TOKEN_DE_API'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "id": "clxyz1234",
    "leadOwner": "usr_abc",
    "name": "João Silva",
    "email": "joao@email.com",
    "phone": "5511999998888",
    "taxId": "12345678909",
    "source": "instagram",
    "profileImage": null,
    "zipCode": "01310-100",
    "state": "SP",
    "city": "São Paulo",
    "neighborhood": "Bela Vista",
    "streetAddress": "Av. Paulista",
    "number": "1000",
    "complement": "Apto 21",
    "description": "Interesse em plano premium",
    "leadType": "PF",
    "leadTemperature": 2,
    "metadata": {
      "tags": ["premium", "interessado"],
      "custom_field": "valor customizado"
    },
    "utms": {
      "utm_source": "instagram",
      "utm_medium": "social",
      "utm_campaign": "campanha_junho"
    },
    "status": "Lead",
    "createdAt": "2025-06-15T14:30:00.000Z",
    "updatedAt": "2025-06-15T14:30:00.000Z"
  }
  ```

  ```json 404 theme={null}
  {
    "error": "Lead not found"
  }
  ```

  ```json 500 theme={null}
  {
    "error": "Error to get lead"
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /lead/{id}
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/{id}:
    get:
      tags:
        - Leads
      summary: Obter Lead
      description: Retorna os dados de um lead específico pelo ID.
      operationId: getLeadById
      parameters:
        - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Lead encontrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Lead'
        '404':
          $ref: '#/components/responses/Error404'
        '500':
          $ref: '#/components/responses/Error500'
components:
  parameters:
    id:
      name: id
      in: path
      required: true
      description: Identificador único do recurso.
      schema:
        type: string
  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:
    Error404:
      description: Recurso não encontrado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    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.

````