--- title: "Buscar leads" method: GET path: "/api/v1/leads" tags: ["Leads"] --- # Buscar leads `GET /api/v1/leads` ## Query parameters - `skip` number - `take` number - `search` string - `complete` LeadFieldsDto - `additionalFields` boolean — Indica se os campos adicionais devem ser incluídos na resposta - `filter` LeadFiltersDto - `tags` string — Lista de IDs de tags. Este campo aceita uma lista de IDs separados por vírgula, com uma operação opcional definida no início da string. Formato: ` ,,` Operação (opcional): define como os IDs serão interpretados. Se omitida, a operação padrão é `some`. Pode ser: - `some` – pelo menos uma das tags. - `every` – todas as tags. - `none` – nenhuma das tags. - `stages` string — ID ou lista de IDs de tags. Este campo aceita um ID ou uma lista de IDs de tags separados por vírgula, com uma operação opcional definida no início da string. Formato: ` , , ` Operação (opcional): define como os IDs serão interpretados. Se omitida, a operação padrão é `some`. Pode ser: - `some` – pelo menos uma das tags. - `every` – todas as tags. - `none` – nenhuma das tags. - `minLastPurchaseDate` string, date-time — Filtrar clientes que fizeram alguma compra na data 'X' ou anterior Formato (ISO 8601): `YYYY-MM-DDTHH:mm:ss.sssZ` - `maxLastPurchaseDate` string, date-time — Filtrar clientes que fizeram alguma compra na data 'X' ou posterior Formato (ISO 8601): `YYYY-MM-DDTHH:mm:ss.sssZ` - `productsInBusiness` number — Quantidade de produtos que há nos negócios do lead - `minBusinessesCount` number — Quantidade mínima de negócios atrelados ao lead - `maxBusinessesCount` number — Quantidade máxima de negócios atrelados ao lead - `lists` string — Lista de IDs de listas. Este campo aceita uma lista de IDs separados por vírgula, com uma operação opcional definida no início da string. Formato: ` ,,` Operação (opcional): define como os IDs serão interpretados. Se omitida, a operação padrão é `some`. Pode ser: - `some` – pelo menos uma das listas. - `every` – todas as listas. - `none` – nenhuma das listas. - `hasMessages` boolean — Leads que já possuem alguma mensagem no CRM - `notHasMessages` boolean — Leads que não possuem nenhuma mensagem no CRM - `source` string — Lead por sua origem - `products` string — Lista de IDs de SKUs. Este campo aceita uma lista de IDs separados por vírgula, com uma operação opcional definida no início da string. Formato: ` ,,` Operação (opcional): define como os IDs serão interpretados. Se omitida, a operação padrão é `some`. Pode ser: - `some` – pelo menos um dos SKUs. - `every` – todos os SKUs. - `none` – nenhum dos SKUs. - `attendant` string — ID de atendente. Este campo aceita uma string referente ao ID do atendente. - `fields` string — Expressões de filtro em campos adicionais. Formato: ` ` idDoCampo: ID do campo adicional. operação: tipo de filtro aplicado. Operações disponíveis: - `contains` – campo contém o valor. - `eq` – campo igual ao valor. - `not` – campo não contém o valor. valorDoCampo: conteúdo do campo adicional. - `createdAtGreaterOrEqual` string, date-time — Data de criação do lead (maior ou igual). Exemplo: filtrar lead que foram criados na data 'X' ou em data posterior Formato (ISO 8601): `YYYY-MM-DDTHH:mm:ss.sssZ` - `createdAtLessOrEqual` string, date-time — Data de criação do lead (menor ou igual). Exemplo: filtrar lead que foram criados na data 'X' ou em data anterior Formato (ISO 8601): `YYYY-MM-DDTHH:mm:ss.sssZ` - `address` string — Filtros de endereço. Formato: ` , , ` Campo: nome do campo a ser consultado. Podem ser utilizados em conjunto conforme o formato acima. Campos disponíveis: - block – bairro - city – cidade - state – estado - country – país ValorDoCampo: conteúdo do campo. ## Response `200` - object - `count` number, required - `data` LeadWithAdditionalFieldsDto[] - `id` string — Id do lead - `createdAt` string, date-time — Data de criação do lead - `name` string — Nome do lead - `image` string — Url da Imagem do lead - `phone` string — Telefone do lead - `rawPhone` string — Telefone do lead (apenas números) - `email` string — Email do lead - `source` string — Origem do lead - `company` string — Empresa do lead - `taxId` string — Documento de identificação - `site` string — Site do lead - `instagram` string — Instagram do lead - `address` LeadAddressDto - `zip` string — Código postal do lead - `address` string — Endereço do lead - `block` string — Bairro do lead - `city` string — Cidade do lead - `state` string — Estado do lead - `country` string — País do lead - `number` string — Número da residência do lead - `tags` TagDto - `id` string — ID da tag - `name` string — Nome da tag - `color` string — Cor da tag em hexadecimal - `description` string — Descrição atribuída a tag - `createdAt` string, date-time — Data de cricão da tag - `lists` string[] — Array de listas atreladas ao lead - `contacts` LeadContactDto - `metrics` LeadMetricsDto - `purchaseCount` number — Quantidade de compras realizadas pelo lead - `lastPurchaseDate` string, date-time — Data da ultima compra realizada - `averageTicket` number — Ticket médio - `totalSpent` number — Total gasto - `openBusinessesCount` number — Quantiade de negócios em aberto - `lostBusinessesCount` number — Quantidade de negócios perdidos - `lostBusinessesTotalValue` number — Valor total dos negócios perdidos - `purchaseFrequency` number — Frequência de compra - `attendant` AttendantDto - `userId` string — ID do usuário - `id` string — ID do usuário como atendente (ID do atendente) - `name` string — Nome do atendente - `email` string — Email do atendente - `phone` string — Telefone do atendente - `imageURL` string — Url da imagem do atendente - `sourceReferral` SourceReferralDto - `sourceId` string — ID referente fonte - `sourceUrl` string — Url referente fonte - `ctwaId` string — CTWA referente (Click to WhatsApp ID) - `additionalFields` AdditionalFieldValueDto - `id` string, required — ID do valor do campo adicional - `additionalField` string, required — Valor do campo adicional - `value` string, required — Valor do campo adicional - `createdAt` string, date-time, required — Data de criação do valor do campo adicional --- [API](https://skmtc.dev/datacrazy/apis/api-crm-datacrazy.md) · [All operations](https://skmtc.dev/datacrazy/apis/api-crm-datacrazy/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/datacrazy/api-crm-datacrazy/revisions/681f3b1fe7c8/schema)