Retorna a lista paginada de leads do workspace. Cada linha traz as colunas da página de leads: owner (responsável) e ownerName (o nome dele, resolvido por página), phones (telefones de contato), primaryAddress (o endereço principal; sem leads:read_addresses vêm só bairro, cidade, UF e código IBGE), customFields (campos sensíveis só com leads:read_sensitive; valores de campos que não existem mais nunca saem do servidor), relativesCount e referredCount. 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. Campos do filtro de leads: id, phone_any (identidade ou qualquer telefone de contato, nos dois formatos do nono dígito), number e q (também leem os telefones de contato), email, nickname, birthday (today, this_week de domingo a sábado ou this_month, no fuso do workspace), birth_date, owner, source, zip, state, city (chave da cidade), district (pares cityKey/districtKey, nunca só o bairro), geo_precision, geo_status, has_address, has_identity, opted_out, whatsapp_opt_in, relation_kind, relatives_count, referred_count, referred_by, custom (validado contra a definição do campo) e area (in com ids de áreas desenhadas, só com leads:read_addresses; por padrão 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 guardado fica dentro da área; com "key":"exact_only" no teste só entram os com posição que identifica a casa, e qualquer outra key responde 400 lead_filter_invalid; uma área apagada, de outro workspace ou privada de outra pessoa responde 400 area_not_found, mais de 20 testes de área no filtro 400 area_too_many), area_approximate (como area, mas lê só os endereços com posição aproximada, de CEP, bairro ou cidade, dentro da área: os leads que uma área exact_only deixou de fora; os testes de area e area_approximate somam no limite de 20) e geo_placement (in, not_in, eq ou neq com on_map, approximate, without_address, not_found ou pending: as mesmas faixas e as mesmas contas de GET /leads/map/summary, para cada contagem virar um link). Um filtro em campo sensível sem leads:read_sensitive responde 403 (custom_field_filter_sensitive_forbidden); um filtro por zip, geo_precision, geo_status, geo_placement, area ou area_approximate sem leads:read_addresses responde 403 (lead_filter_address_forbidden); um filtro inválido responde 400 (lead_filter_invalid); uma busca sem palavra de 2 caracteres ou mais responde 400 (lead_search_too_short). city e district aceitam a chave em qualquer grafia (SP:São Paulo/Jd. Paulista) e comparam pela chave guardada. A ordenação aceita múltiplas chaves. A página lê primeiro os ids da página e depois os resumos só dessas linhas. page começa em 1 e pageSize vai de 1 a 100 (padrão 20); fora disso a resposta é 400 pagination_invalid.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||