Listar Leads

curl --request GET \
  --url 'https://crm.wavups.com/api/v1/lead?startDate=2025-01-01T00:00:00Z&endDate=2025-12-31T23:59:59Z&source=instagram' \
  --header 'Token: SEU_TOKEN_DE_API'

[
  {
    "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",
    "accountCRMLeadLabelAssignments": [
      {
        "AccountLabel": {
          "id": "lbl_001",
          "name": "Quente",
          "color": "#ef4444"
        }
      }
    ],
    "accountExternalConversations": [
      {
        "id": "clconv001",
        "contactName": "João Silva",
        "contactPhone": "5511999998888",
        "contactUsername": null,
        "status": "active",
        "unreadCount": 0,
        "lastMessageAt": "2025-06-15T15:00:00.000Z",
        "accountChatSectorId": "csector001",
        "conversationOwnerId": "usr_abc",
        "createdAt": "2025-06-15T14:30:00.000Z",
        "AccountChatSector": {
          "id": "csector001",
          "name": "Comercial",
          "color": "#3B82F6"
        },
        "PlatformIntegration": {
          "name": "WhatsApp Business"
        }
      }
    ]
  }
]

{
  "error": "Error to get leads"
}

GET

lead

curl --request GET \
  --url 'https://crm.wavups.com/api/v1/lead?startDate=2025-01-01T00:00:00Z&endDate=2025-12-31T23:59:59Z&source=instagram' \
  --header 'Token: SEU_TOKEN_DE_API'

[
  {
    "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",
    "accountCRMLeadLabelAssignments": [
      {
        "AccountLabel": {
          "id": "lbl_001",
          "name": "Quente",
          "color": "#ef4444"
        }
      }
    ],
    "accountExternalConversations": [
      {
        "id": "clconv001",
        "contactName": "João Silva",
        "contactPhone": "5511999998888",
        "contactUsername": null,
        "status": "active",
        "unreadCount": 0,
        "lastMessageAt": "2025-06-15T15:00:00.000Z",
        "accountChatSectorId": "csector001",
        "conversationOwnerId": "usr_abc",
        "createdAt": "2025-06-15T14:30:00.000Z",
        "AccountChatSector": {
          "id": "csector001",
          "name": "Comercial",
          "color": "#3B82F6"
        },
        "PlatformIntegration": {
          "name": "WhatsApp Business"
        }
      }
    ]
  }
]

{
  "error": "Error to get leads"
}

Requisição

GET https://crm.wavups.com/api/v1/lead

string

required

Seu token de autenticação.

Query Parameters

string

Data de início para filtrar leads pelo campo createdAt. Deve ser uma data válida no formato ISO 8601 (ex: 2025-01-01T00:00:00Z). Utilizado em conjunto com endDate.

string

Data de fim para filtrar leads pelo campo createdAt. Deve ser uma data válida no formato ISO 8601 (ex: 2025-12-31T23:59:59Z). Utilizado em conjunto com startDate.

number

Filtra leads pela temperatura: 1 (Frio), 2 (Morno) ou 3 (Quente).

string

Filtra leads pela origem (ex: site, instagram, indicacao).

string

Filtra leads por número de telefone exato.

string

Filtra leads por número de CPF ou CNPJ exato.

string

Filtra leads pelo ID do usuário responsável pelo lead.

string

Filtra leads pelo tipo (ex: PF, PJ).

string

Filtra leads que possuem a etiqueta com o ID informado.

Resposta

Retorna um array de objetos de lead. Os campos accountId e updatedAt são omitidos na resposta.

string

Identificador único do lead.

string | null

ID do usuário responsável pelo lead.

string

Nome do lead.

string | null

E-mail do lead.

string | null

Telefone do lead.

string | null

CPF/CNPJ do lead.

string | null

Origem do lead.

string | null

URL da imagem de perfil do lead.

string | null

CEP do endereço do lead.

string | null

Estado do lead.

string | null

Cidade do lead.

string | null

Bairro do lead.

string | null

Logradouro do lead.

string | null

Número do endereço.

string | null

Complemento do endereço.

string | null

Descrição ou observações sobre o lead.

string | null

Tipo do lead (ex: PF, PJ).

number | null

Temperatura do lead: 1 (Frio), 2 (Morno) ou 3 (Quente).

object | null

Metadados adicionais do lead em formato JSON.

object | null

Parâmetros UTM associados ao lead em formato JSON.

string

Status atual do lead. Padrão: Lead.

string

Data e horário de criação do lead (ISO 8601).

array

Lista de etiquetas atribuídas ao lead.

Show Propriedades da etiqueta

string

ID da etiqueta.

string

Nome da etiqueta.

string

Cor da etiqueta (hex ou nome).

array

Lista de conversas vinculadas ao lead (sem o conteúdo da última mensagem).

Show Propriedades da Conversa

string

Identificador único da conversa.

string

Nome do contato.

string | null

Telefone do contato.

string | null

Username do contato.

string

Status da conversa (active, closed, etc.).

number

Quantidade de mensagens não lidas.

string | null

Data e hora da última mensagem (ISO 8601).

string | null

ID do setor do chat associado.

string | null

ID do responsável pela conversa.

string

Data de criação da conversa (ISO 8601).

object | null

Dados do setor da conversa (id, name, color).

object | null

Dados da plataforma integrada (name).

Exemplos

curl --request GET \
  --url 'https://crm.wavups.com/api/v1/lead?startDate=2025-01-01T00:00:00Z&endDate=2025-12-31T23:59:59Z&source=instagram' \
  --header 'Token: SEU_TOKEN_DE_API'

[
  {
    "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",
    "accountCRMLeadLabelAssignments": [
      {
        "AccountLabel": {
          "id": "lbl_001",
          "name": "Quente",
          "color": "#ef4444"
        }
      }
    ],
    "accountExternalConversations": [
      {
        "id": "clconv001",
        "contactName": "João Silva",
        "contactPhone": "5511999998888",
        "contactUsername": null,
        "status": "active",
        "unreadCount": 0,
        "lastMessageAt": "2025-06-15T15:00:00.000Z",
        "accountChatSectorId": "csector001",
        "conversationOwnerId": "usr_abc",
        "createdAt": "2025-06-15T14:30:00.000Z",
        "AccountChatSector": {
          "id": "csector001",
          "name": "Comercial",
          "color": "#3B82F6"
        },
        "PlatformIntegration": {
          "name": "WhatsApp Business"
        }
      }
    ]
  }
]

{
  "error": "Error to get leads"
}

Authorizations

Token

string

header

required

Token de autenticacao gerado na plataforma WavUps CRM.

Query Parameters

startDate

string<date-time>

Data de início para filtrar leads pelo campo createdAt (ISO 8601, ex: 2025-01-01T00:00:00Z).

endDate

string<date-time>

Data de fim para filtrar leads pelo campo createdAt (ISO 8601, ex: 2025-12-31T23:59:59Z).

temperature

enum<integer>

Filtra leads pela temperatura: 1 (Frio), 2 (Morno) ou 3 (Quente).

Available options:

1,

2,

3

source

string

Filtra leads pela origem (ex: site, instagram, indicacao).

phone

string

Filtra leads por número de telefone exato.

taxId

string

Filtra leads por número de CPF ou CNPJ exato.

leadOwner

string

Filtra leads pelo ID do usuário responsável.

leadType

string

Filtra leads pelo tipo (ex: PF, PJ).

labelId

string

Filtra leads que possuem a etiqueta com o ID informado.

leadTemperature

enum<integer>

Filtra leads pela temperatura (alias para temperature): 1 (Frio), 2 (Morno) ou 3 (Quente).

Available options:

1,

2,

3

Response

Lista de leads retornada com sucesso.

string

leadOwner

string | null

name

string

string | null

phone

string | null

Telefone no formato 5547999999999 (pais + DDD + numero, sem espacos ou simbolos).

Example:

"5547999999999"

taxId

string | null

CPF ou CNPJ do lead.

Example:

"12345678909"

source

string | null

profileImage

string | null

zipCode

string | null

state

string | null

city

string | null

neighborhood

string | null

streetAddress

string | null

number

string | null

complement

string | null

description

string | null

leadType

string | null

leadTemperature

number | null

Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).

status

string

metadata

object | null

Metadados adicionais do lead em formato JSON.

utms

object | null

Parâmetros UTM associados ao lead em formato JSON.

Show child attributes

createdAt

string<date-time>

accountExternalConversations

object[]

Lista de conversas vinculadas ao lead.

Show child attributes

Visão Geral

Membros da Conta

Integrações

WhatsApp

Instagram

Leads

Categorias

Produtos

Atendimentos

Agendamentos

Conversas

Setores do Chat

Pipeline de CRM

Estágios do Pipeline

Negócios do Pipeline

Requisição

Query Parameters

Resposta

Exemplos

Authorizations

Query Parameters

Response

​Requisição

​Query Parameters

​Resposta

​Exemplos

Authorizations

Query Parameters

Response

Requisição

Query Parameters

Resposta

Exemplos