Catálogo de campos de filtro

Cada campo do filtro estruturado, com os operadores, o formato do valor e os limites.

Esta página é gerada a partir do registro de campos que a API usa para validar cada filtro, então traz exatamente os campos e operadores aceitos hoje. Para a estrutura do filtro, como enviá-lo e quais recursos o aceitam, leia antes o guia Filtros.

Cada predicado do filtro tem field, operator, values e, em alguns campos, key. Valores vazios ou só com espaços são ignorados.

Operadores

OperadorSignificadoValores
eqIgual ao valor.Um
neqDiferente do valor.Um
inIgual a qualquer um dos valores.Um ou mais
not_inDiferente de todos os valores.Um ou mais
containsContém o trecho de texto.Um
gteMaior ou igual ao valor.Um
lteMenor ou igual ao valor.Um
betweenEntre os dois valores, inclusive.Exatamente dois
beforeAntes da data, sem incluí-la.Um
afterDepois da data, sem incluí-la.Um
is_setO campo está preenchido.Nenhum
is_emptyO campo está vazio.Nenhum
is_trueO campo é verdadeiro.Nenhum
is_falseO campo é falso.Nenhum

Operadores sem valor ignoram values.

Tipos de valor

TipoFormato
TextoTexto livre.
BuscaUm trecho de texto, procurado com contains.
NúmeroNúmero decimal com ponto e sem separador de milhar, como 1500 ou 12.5. Vírgula, x e _ recusam o valor.
DataData AAAA-MM-DD ou data e hora RFC 3339, como 2026-10-01T09:00:00-03:00.
Sim ou nãoSem valor em is_true e is_false; em eq, o valor é true ou false.
IdentificadoresIdentificadores de registros, um por valor.
Lista de valoresUm dos valores aceitos pelo campo, um por valor.

Índice

CampoOnde valeTipo
ageLeadsNúmero
areaLeadsIdentificadores
area_approximateLeadsIdentificadores
birth_dateLeadsData
birthdayLeadsLista de valores
blockedLeadsSim ou não
campaignConversas (CRM) e LeadsIdentificadores
campaign_countLeadsNúmero
campaign_statusLeadsLista de valores
carteiraNegociaçõesIdentificadores
channelConversas (CRM) e LeadsLista de valores
cityLeadsIdentificadores
close_dateNegociaçõesData
companyLeadsIdentificadores
created_atConversas (CRM), Negociações e LeadsData
customNegociações e LeadsConforme o campo
districtLeadsIdentificadores
emailLeadsTexto
geo_placementLeadsLista de valores
geo_precisionLeadsLista de valores
geo_statusLeadsLista de valores
has_addressLeadsSim ou não
has_identityLeadsSim ou não
idLeadsIdentificadores
labelConversas (CRM) e LeadsIdentificadores
last_activity_atConversas (CRM) e LeadsData
lost_reasonNegociaçõesIdentificadores
memory_authorLeadsLista de valores
memory_categoryLeadsLista de valores
memory_countLeadsNúmero
memory_textLeadsBusca
memory_updated_atLeadsData
nameLeadsTexto
nicknameLeadsBusca
numberLeadsTexto
opt_out_sourceLeadsLista de valores
opted_outLeadsSim ou não
opted_out_atLeadsData
originConversas (CRM)Lista de valores
ownerConversas (CRM), Negociações e LeadsIdentificadores
phone_anyLeadsTexto
pipelineNegociaçõesIdentificadores
queryConversas (CRM), Negociações e LeadsBusca
referred_byLeadsIdentificadores
referred_countLeadsNúmero
relation_kindLeadsLista de valores
relatives_countLeadsNúmero
sentimentLeadsLista de valores
sourceConversas (CRM), Negociações e LeadsLista de valores
stageConversas (CRM), Negociações e LeadsIdentificadores
stateLeadsIdentificadores
statusConversas (CRM) e NegociaçõesLista de valores
unreadConversas (CRM)Sim ou não
updated_atConversas (CRM), Negociações e LeadsData
valueNegociaçõesNúmero
whatsapp_opt_inLeadsSim ou não
window_openConversas (CRM) e LeadsSim ou não
zipLeadsIdentificadores

Campos

age

Idade do lead.

ItemDetalhe
Campoage
Onde valeLeads
TipoNúmero
Operadoreseq, neq, gte, lte, between, is_set e is_empty
ValoresNúmero.

area

Áreas desenhadas no mapa de leads.

ItemDetalhe
Campoarea
Onde valeLeads
TipoIdentificadores
Operadoresin
ValoresIds (UUID) de áreas desenhadas. Uma área apagada, de outro workspace ou privada de outra pessoa recusa o filtro com area_not_found. Os testes de area e area_approximate de um filtro somam no máximo 20 áreas (area_too_many). Exige a permissão de ler endereços completos (leads:read_addresses).
Chave (key)Vazia: entram os endereços com posição que identifica a casa e também os com posição aproximada (de CEP, bairro ou cidade) cujo ponto fica dentro da área. exact_only: só os com posição que identifica a casa. Outra chave recusa o filtro.
LimiteAté 20 valores por predicado.
ValidaçãoO formato de cada valor é conferido na validação do filtro, em qualquer recurso: um valor fora do formato recusa o filtro inteiro.

area_approximate

Leads com posição aproximada dentro de áreas desenhadas.

ItemDetalhe
Campoarea_approximate
Onde valeLeads
TipoIdentificadores
Operadoresin
ValoresIds (UUID) de áreas desenhadas: só os endereços com posição aproximada (de CEP, bairro ou cidade) dentro da área, os que uma área exact_only deixa de fora. Exige a permissão de ler endereços completos (leads:read_addresses).
Chave (key)Sempre vazia. Outra chave recusa o filtro.
LimiteAté 20 valores por predicado.
ValidaçãoO formato de cada valor é conferido na validação do filtro, em qualquer recurso: um valor fora do formato recusa o filtro inteiro.

birth_date

Data de nascimento do lead.

ItemDetalhe
Campobirth_date
Onde valeLeads
TipoData
Operadoresbefore, after, between, gte, lte, is_set e is_empty
ValoresData.

birthday

Aniversário do lead, pelo dia e mês de nascimento.

ItemDetalhe
Campobirthday
Onde valeLeads
TipoLista de valores
Operadoreseq e in
Valorestoday, this_week ou this_month, no fuso do workspace. A semana vai de domingo a sábado.
ValidaçãoO formato de cada valor é conferido na validação do filtro, em qualquer recurso: um valor fora do formato recusa o filtro inteiro.

blocked

O lead está bloqueado.

ItemDetalhe
Campoblocked
Onde valeLeads
TipoSim ou não
Operadoresis_true, is_false e eq
ValoresSim ou não.

campaign

Campanha.

ItemDetalhe
Campocampaign
Onde valeConversas (CRM) e Leads
TipoIdentificadores
Operadoresin, not_in, eq, neq, is_set e is_empty
ValoresIds de campanha. Em conversas, a campanha da conversa; em leads, as campanhas de WhatsApp oficial em que o lead está.

campaign_count

Em quantas campanhas de WhatsApp oficial o lead está.

ItemDetalhe
Campocampaign_count
Onde valeLeads
TipoNúmero
Operadoreseq, neq, gte, lte, between, is_set e is_empty
ValoresNúmero.

campaign_status

Status de envio do lead numa campanha de WhatsApp oficial.

ItemDetalhe
Campocampaign_status
Onde valeLeads
TipoLista de valores
Operadoreseq, neq, in, not_in, is_set e is_empty
ValoresPENDING, SENT, DELIVERED, READ, FAILED ou NOT_ELIGIBLE_POSSIBLE_SPAM, em maiúsculas.

carteira

Carteira da negociação.

ItemDetalhe
Campocarteira
Onde valeNegociações
TipoIdentificadores
Operadoresin, not_in, eq, neq, is_set e is_empty
ValoresIds de carteira.

channel

Canal.

ItemDetalhe
Campochannel
Onde valeConversas (CRM) e Leads
TipoLista de valores
Operadoreseq, neq, in, not_in, is_set e is_empty
Valoresemail, facebook, instagram, mercadolivre, rcs, sms, telegram, tiktok, unofficial_whatsapp, webchat ou whatsapp. Em conversas, a conversa tem mensagens no canal; em leads, o lead tem contato no canal.

city

Cidade do endereço principal.

ItemDetalhe
Campocity
Onde valeLeads
TipoIdentificadores
Operadoresin, not_in, eq, neq, is_set e is_empty
ValoresChave da cidade no formato uf:cidade, como sp:campinas. A cidade pode vir em qualquer grafia (SP:Campinas vale o mesmo); a comparação usa a chave guardada.
ValidaçãoO formato de cada valor é conferido na validação do filtro, em qualquer recurso: um valor fora do formato recusa o filtro inteiro.

close_date

Data prevista de fechamento da negociação.

ItemDetalhe
Campoclose_date
Onde valeNegociações
TipoData
Operadoresbefore, after, between, gte, lte, is_set e is_empty
ValoresData.

company

Empresa do lead.

ItemDetalhe
Campocompany
Onde valeLeads
TipoIdentificadores
Operadoresin, not_in, eq, neq, is_set e is_empty
ValoresIds (UUID) de empresas. neq e not_in incluem os leads sem empresa.
ValidaçãoO formato de cada valor é conferido na validação do filtro, em qualquer recurso: um valor fora do formato recusa o filtro inteiro.

created_at

Data de criação.

ItemDetalhe
Campocreated_at
Onde valeConversas (CRM), Negociações e Leads
TipoData
Operadoresbefore, after, between, gte, lte, is_set e is_empty
ValoresData.

custom

Campo personalizado.

ItemDetalhe
Campocustom
Onde valeNegociações e Leads
TipoConforme o campo
Operadoreseq, neq, in, not_in, contains, gte, lte, between, before, after, is_true, is_false, is_set e is_empty
ValoresConforme o tipo do campo: texto, número, data, sim ou não (true ou false) ou uma opção da lista. Os operadores também seguem o tipo: texto aceita eq, neq, in, not_in, contains, is_set e is_empty; número, eq, neq, gte, lte, between, is_set e is_empty; data, before, after, gte, lte, between, is_set e is_empty; sim ou não, is_true, is_false, eq, is_set e is_empty; seleção e seleção múltipla, eq, neq, in, not_in, is_set e is_empty. Uma chave que não existe, um operador ou um valor que não serve ao tipo recusam o filtro. Filtrar por um campo sensível exige a permissão de ler dados sensíveis.
Chave (key)Obrigatória: a chave do campo personalizado, sem diferença entre maiúsculas e minúsculas.

district

Bairro do endereço principal.

ItemDetalhe
Campodistrict
Onde valeLeads
TipoIdentificadores
Operadoresin, not_in, eq, neq, is_set e is_empty
ValoresPar uf:cidade/bairro, como sp:sao paulo/jardim paulista, nunca só o bairro. Aceita qualquer grafia (SP:São Paulo/Jd. Paulista vale o mesmo).
LimiteAté 200 valores por predicado.
ValidaçãoO formato de cada valor é conferido na validação do filtro, em qualquer recurso: um valor fora do formato recusa o filtro inteiro.

email

E-mail do lead.

ItemDetalhe
Campoemail
Onde valeLeads
TipoTexto
Operadoreseq, neq, in, not_in, contains, is_set e is_empty
ValoresTexto.

geo_placement

Faixa do lead no mapa, as mesmas contagens do resumo do mapa de leads.

ItemDetalhe
Campogeo_placement
Onde valeLeads
TipoLista de valores
Operadoresin, not_in, eq e neq
Valoreson_map, approximate, without_address, not_found ou pending. Exige a permissão de ler endereços completos (leads:read_addresses).
ValidaçãoO formato de cada valor é conferido na validação do filtro, em qualquer recurso: um valor fora do formato recusa o filtro inteiro.

geo_precision

Precisão da posição do endereço principal no mapa.

ItemDetalhe
Campogeo_precision
Onde valeLeads
TipoLista de valores
Operadoreseq, neq, in, not_in, is_set e is_empty
Valoresexact, address, street, postal_code, district ou city, da mais precisa para a menos precisa; outro valor recusa o filtro. Exige a permissão de ler endereços completos (leads:read_addresses).

geo_status

Situação da localização do endereço principal.

ItemDetalhe
Campogeo_status
Onde valeLeads
TipoLista de valores
Operadoreseq, neq, in, not_in, is_set e is_empty
Valorespending, located, approximate, not_found ou unavailable; outro valor recusa o filtro. Exige a permissão de ler endereços completos (leads:read_addresses).

has_address

O lead tem endereço principal.

ItemDetalhe
Campohas_address
Onde valeLeads
TipoSim ou não
Operadoresis_true, is_false e eq
ValoresSim ou não.

has_identity

O lead tem número de identidade.

ItemDetalhe
Campohas_identity
Onde valeLeads
TipoSim ou não
Operadoresis_true, is_false e eq
ValoresSim ou não.

id

O próprio lead.

ItemDetalhe
Campoid
Onde valeLeads
TipoIdentificadores
Operadoresin, not_in, eq e neq
ValoresIds (UUID) de leads.
ValidaçãoO formato de cada valor é conferido na validação do filtro, em qualquer recurso: um valor fora do formato recusa o filtro inteiro.

label

Etiqueta.

ItemDetalhe
Campolabel
Onde valeConversas (CRM) e Leads
TipoIdentificadores
Operadoresin, not_in, eq, neq, is_set e is_empty
ValoresIds de etiqueta. Em leads, vale a etiqueta de qualquer conversa do lead.

last_activity_at

Última atividade.

ItemDetalhe
Campolast_activity_at
Onde valeConversas (CRM) e Leads
TipoData
Operadoresbefore, after, between, gte, lte, is_set e is_empty
ValoresData. Em conversas, a data da última mensagem; em leads, a mais recente entre as mensagens em qualquer canal, a janela de atendimento e as campanhas de WhatsApp oficial.

lost_reason

Motivo de perda da negociação.

ItemDetalhe
Campolost_reason
Onde valeNegociações
TipoIdentificadores
Operadoresin, not_in, eq, neq, is_set e is_empty
ValoresIds de motivo de perda.

memory_author

Quem registrou uma memória do lead.

ItemDetalhe
Campomemory_author
Onde valeLeads
TipoLista de valores
Operadoreseq, neq, in, not_in, is_set e is_empty
Valoreshuman, ai, workflow, system ou campaign.

memory_category

Categoria de uma memória do lead.

ItemDetalhe
Campomemory_category
Onde valeLeads
TipoLista de valores
Operadoreseq, neq, in, not_in, is_set e is_empty
Valorespersonal, preference, deal, objection, commitment, event ou other.

memory_count

Quantas memórias o lead tem.

ItemDetalhe
Campomemory_count
Onde valeLeads
TipoNúmero
Operadoreseq, neq, gte, lte, between, is_set e is_empty
ValoresNúmero.

memory_text

Texto das memórias do lead.

ItemDetalhe
Campomemory_text
Onde valeLeads
TipoBusca
Operadorescontains
ValoresUm trecho de texto.

memory_updated_at

Data da memória alterada por último.

ItemDetalhe
Campomemory_updated_at
Onde valeLeads
TipoData
Operadoresbefore, after, between, gte, lte, is_set e is_empty
ValoresData.

name

Nome do lead.

ItemDetalhe
Camponame
Onde valeLeads
TipoTexto
Operadoreseq, neq, in, not_in, contains, is_set e is_empty
ValoresTexto.

nickname

Apelido do lead.

ItemDetalhe
Camponickname
Onde valeLeads
TipoBusca
Operadorescontains, is_set e is_empty
ValoresUm trecho de texto.

number

Número de identidade do lead e telefones de contato.

ItemDetalhe
Camponumber
Onde valeLeads
TipoTexto
Operadoreseq, neq, in, not_in, contains, is_set e is_empty
ValoresEm eq, neq, in e not_in, o número como guardado: só dígitos, com DDI, como 5511987654321. Em contains, um trecho de dígitos. Para comparar em qualquer formato e nos dois formatos do nono dígito, use phone_any.

opt_out_source

Como o lead saiu: quem ou o que registrou o pedido para não receber mensagens.

ItemDetalhe
Campoopt_out_source
Onde valeLeads
TipoLista de valores
Operadoresin, not_in, eq e neq
Valoresbutton_reply, template_word, campaign_word, workspace_word, keyword, ai_agent, workflow, manual, conversation_request, elo ou api; outro valor recusa o filtro.

opted_out

O lead pediu para não receber mensagens no WhatsApp.

ItemDetalhe
Campoopted_out
Onde valeLeads
TipoSim ou não
Operadoresis_true, is_false e eq
ValoresSim ou não.

opted_out_at

Data em que o lead pediu para não receber mensagens.

ItemDetalhe
Campoopted_out_at
Onde valeLeads
TipoData
Operadoresbefore, after, between, gte, lte, is_set e is_empty
ValoresData.

origin

Como a conversa começou, pela primeira mensagem.

ItemDetalhe
Campoorigin
Onde valeConversas (CRM)
TipoLista de valores
Operadoresin, not_in, eq e neq
Valoresreceptive (o contato escreveu primeiro), campaign (começou por uma mensagem de campanha), outreach (a equipe, a IA ou um fluxo começou) ou unknown. Outro valor recusa o filtro com conversation_origin_invalid.

owner

Responsável.

ItemDetalhe
Campoowner
Onde valeConversas (CRM), Negociações e Leads
TipoIdentificadores
Operadoresin, not_in, eq, neq, is_set e is_empty
ValoresEm conversas, o responsável da conversa: o id do usuário, ai:<id do agente> ou workflow:<id do fluxo>. Em negociações, o ownerId da negociação. Em leads, o id do usuário (UUID em minúsculas), ai:<id do agente> ou workflow:<id do fluxo>; outro formato recusa o filtro.

phone_any

Número de identidade ou qualquer telefone de contato do lead.

ItemDetalhe
Campophone_any
Onde valeLeads
TipoTexto
Operadoresin, not_in, eq e neq
ValoresTelefone brasileiro com DDD, em qualquer formato, como (11) 98765-4321 ou 5511987654321. Cada valor é comparado nos dois formatos do nono dígito.
ValidaçãoO formato de cada valor é conferido na validação do filtro, em qualquer recurso: um valor fora do formato recusa o filtro inteiro.

pipeline

Funil da negociação.

ItemDetalhe
Campopipeline
Onde valeNegociações
TipoIdentificadores
Operadoresin, not_in, eq, neq, is_set e is_empty
ValoresIds de funil.

query

Busca livre.

ItemDetalhe
Campoquery
Onde valeConversas (CRM), Negociações e Leads
TipoBusca
Operadorescontains
ValoresUm trecho de texto. Em conversas, procura no nome e no número do lead e no texto das mensagens; em negociações, no título. Em leads, cada palavra de 2 caracteres ou mais (até 8 palavras) precisa aparecer no nome, no apelido, no bairro ou na cidade do endereço principal ou numa memória, e 4 dígitos ou mais procuram no número e nos telefones de contato; sem nenhuma palavra utilizável, o filtro é recusado.

referred_by

Leads indicados por um lead.

ItemDetalhe
Camporeferred_by
Onde valeLeads
TipoIdentificadores
Operadoresin, not_in, eq e neq
ValoresIds (UUID) do lead que indicou.
ValidaçãoO formato de cada valor é conferido na validação do filtro, em qualquer recurso: um valor fora do formato recusa o filtro inteiro.

referred_count

Quantos leads o lead indicou.

ItemDetalhe
Camporeferred_count
Onde valeLeads
TipoNúmero
Operadoreseq, neq, gte, lte, between, is_set e is_empty
ValoresNúmero.

relation_kind

Tipo de relação com outro lead, nos dois sentidos.

ItemDetalhe
Camporelation_kind
Onde valeLeads
TipoLista de valores
Operadoreseq, neq, in, not_in, is_set e is_empty
Valoresspouse, partner, parent, child, sibling, grandparent, grandchild, uncle_aunt, nephew_niece, cousin, in_law, relative, referred ou referred_by; outro valor recusa o filtro.

relatives_count

Quantos familiares o lead tem.

ItemDetalhe
Camporelatives_count
Onde valeLeads
TipoNúmero
Operadoreseq, neq, gte, lte, between, is_set e is_empty
ValoresNúmero.

sentiment

Sentimento do lead.

ItemDetalhe
Camposentiment
Onde valeLeads
TipoLista de valores
Operadoresin, not_in, eq e neq
Valorespositive, neutral ou negative.
ValidaçãoO formato de cada valor é conferido na validação do filtro, em qualquer recurso: um valor fora do formato recusa o filtro inteiro.

source

Origem do registro.

ItemDetalhe
Camposource
Onde valeConversas (CRM), Negociações e Leads
TipoLista de valores
Operadoreseq, neq, in, not_in, is_set e is_empty
ValoresEm conversas, o canal da conversa: email, facebook, instagram, mercadolivre, rcs, sms, telegram, tiktok, unofficial_whatsapp, webchat ou whatsapp. Em negociações, o texto gravado em source da negociação, comparado por igualdade. Em leads, manual, import, channel, form ou workflow; outro valor recusa o filtro.

stage

Etapa.

ItemDetalhe
Campostage
Onde valeConversas (CRM), Negociações e Leads
TipoIdentificadores
Operadoresin, not_in, eq, neq, is_set e is_empty
ValoresIds de etapa. Em leads, vale a etapa de qualquer conversa do lead.

state

UF do endereço principal.

ItemDetalhe
Campostate
Onde valeLeads
TipoIdentificadores
Operadoresin, not_in, eq, neq, is_set e is_empty
ValoresUF com duas letras, como SP.
ValidaçãoO formato de cada valor é conferido na validação do filtro, em qualquer recurso: um valor fora do formato recusa o filtro inteiro.

status

Status.

ItemDetalhe
Campostatus
Onde valeConversas (CRM) e Negociações
TipoLista de valores
Operadoreseq, neq, in, not_in, is_set e is_empty
ValoresEm conversas, new, ongoing ou finished. Em negociações, open, won ou lost.

unread

A conversa tem mensagens do contato ainda não lidas.

ItemDetalhe
Campounread
Onde valeConversas (CRM)
TipoSim ou não
Operadoresis_true, is_false e eq
ValoresSim ou não.

updated_at

Data da última alteração.

ItemDetalhe
Campoupdated_at
Onde valeConversas (CRM), Negociações e Leads
TipoData
Operadoresbefore, after, between, gte, lte, is_set e is_empty
ValoresData.

value

Valor da negociação.

ItemDetalhe
Campovalue
Onde valeNegociações
TipoNúmero
Operadoreseq, neq, gte, lte, between, is_set e is_empty
ValoresNúmero comparado com o valor em centavos (100000 é R$ 1.000,00).

whatsapp_opt_in

O lead tem consentimento registrado para o WhatsApp.

ItemDetalhe
Campowhatsapp_opt_in
Onde valeLeads
TipoSim ou não
Operadoresis_true, is_false e eq
ValoresSim ou não.

window_open

A janela de atendimento de 24 horas do WhatsApp oficial está aberta.

ItemDetalhe
Campowindow_open
Onde valeConversas (CRM) e Leads
TipoSim ou não
Operadoresis_true, is_false e eq
ValoresSim ou não.

zip

CEP do endereço principal.

ItemDetalhe
Campozip
Onde valeLeads
TipoIdentificadores
Operadoresin, not_in, eq, neq, is_set e is_empty
ValoresCEP de 8 dígitos, com ou sem pontuação, como 01310-100. Exige a permissão de ler endereços completos (leads:read_addresses).
LimiteAté 200 valores por predicado.
ValidaçãoO formato de cada valor é conferido na validação do filtro, em qualquer recurso: um valor fora do formato recusa o filtro inteiro.