Listar leads

get

https://example.com/leads

Retorna a lista paginada de leads do workspace. Aceita os filtros simples por querystring (nome, número, período, faixa etária, campanha, canal, bloqueio, janela, memórias) e/ou um filtro estruturado filter (crmfilter em JSON, opcionalmente em base64) com grupos AND/OR. A ordenação aceita múltiplas chaves.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

Número da página (inicia em 1)

pageSize

integer

Itens por página (máximo 200)

sort

string

Ordenação: createdAt, updatedAt, lastActivityAt, name, number, age, campaigns, memories, lastMemoryAt (ex.: lastActivityAt:desc,name:asc)

order

string

Direção padrão quando o sort não a informa ('asc' ou 'desc')

filter

string

Filtro crmfilter em JSON (opcionalmente codificado em base64)

string

Busca livre por nome, número ou conteúdo das memórias

number

string

Filtrar por número de telefone

name

string

Filtrar por nome

hasName

boolean

Possui nome preenchido

ageFrom

integer

Idade mínima

ageTo

integer

Idade máxima

blocked

boolean

Somente bloqueados / não bloqueados

windowOpen

boolean

Janela de 24h aberta

channel

array of strings

Canais (whatsapp, unofficial_whatsapp, telegram, instagram)

channel

hasWhatsAppCampaign

boolean

Possui campanha de WhatsApp

campaignId

array of strings

IDs de campanha

campaignId

campaignStatus

array of strings

Status de envio na campanha

campaignStatus

campaignsFrom

integer

Mínimo de campanhas

campaignsTo

integer

Máximo de campanhas

stageId

array of strings

IDs de etapa do CRM

stageId

labelId

array of strings

IDs de etiqueta do CRM

labelId

hasMemory

boolean

Possui memórias registradas

memoryCategory

array of strings

Categorias de memória

memoryCategory

memoryAuthor

array of strings

Autor da memória (human, ai, system)

memoryAuthor

memoryText

string

Busca no conteúdo das memórias

memoriesFrom

integer

Mínimo de memórias

memoriesTo

integer

Máximo de memórias

memoryFrom

string

Memória atualizada a partir de (RFC3339 ou YYYY-MM-DD)

memoryTo

string

Memória atualizada até (RFC3339 ou YYYY-MM-DD)

createdFrom

string

Criados a partir de (RFC3339 ou YYYY-MM-DD)

createdTo

string

Criados até (RFC3339 ou YYYY-MM-DD)

updatedFrom

string

Atualizados a partir de (RFC3339 ou YYYY-MM-DD)

updatedTo

string

Atualizados até (RFC3339 ou YYYY-MM-DD)

activityFrom

string

Última atividade a partir de (RFC3339 ou YYYY-MM-DD)

activityTo

string

Última atividade até (RFC3339 ou YYYY-MM-DD)

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

500Internal Server Error