--- title: "Buscar atividades" method: GET path: "/api/v1/activities" tags: ["Atividades"] --- # Buscar atividades `GET /api/v1/activities` ## Query parameters - `skip` number - `take` number - `search` string - `filter` ActivitiesFiltersDto - `attendantId` string — ID ou lista de IDs de atendentes. Formato: `,,` Detalhes: - Este campo aceita um ID ou uma lista de IDs separados por vírgula. - `startDate` string, date-time — Atividades marcadas a partir da data. Formato (ISO 8601): `YYYY-MM-DDTHH:mm:ss.sssZ` - `startDateLessThan` string, date-time — Atividades marcadas para data anterior ou na mesma data. Formato (ISO 8601): `YYYY-MM-DDTHH:mm:ss.sssZ` - `typeId` string — ID do tipo de atividade. Formato: `` Detalhes: - Este campo aceita um ID. - `isCompleted` boolean — Valor boneano que indica se a atividade já foi concluida ou não. Para retornar todas as ativiaddes deixe o campo vazio ## Response `200` - object - `count` number, required - `data` ActivityDto[] - `id` string — ID da atividade. - `createdAt` string, date-time — Data de criação da atividade. - `title` string, required — Título da atividade. - `description` string — Descrição da atividade. - `startDate` string, date-time — Filtro de intervalo, negócios que estão em negociação ou estavam em negociação em determinado intervalo. Formato (ISO 8601): `YYYY-MM-DDTHH:mm:ss.sssZ` - `endDate` string, date-time — Filtro de intervalo, negócios que estão em negociação ou estavam em negociação em determinado intervalo. Formato (ISO 8601): `YYYY-MM-DDTHH:mm:ss.sssZ` - `isCompleted` boolean — Valor boneano que indica se a atividade está concluida ou não - `lead` LeadDto - `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) - `business` BusinessDto - `id` string — ID do negócio. - `createdAt` string, date-time — Data de criação do negócio. - `stageId` string — ID do estágio atual do negócio. - `leadId` string — ID do lead associado ao negócio. - `attendantId` string — ID do atendente responsável pelo negócio. - `nextActivityId` string — ID da próxima atividade relacionada ao negócio. - `total` number — Valor total do negócio. - `discount` number — Valor de desconto aplicado ao negócio. - `addition` number — Valor de acréscimos aplicados ao negócio. - `shipping` number — Valor do frete relacionado ao negócio. - `coupon` string — Cupom de desconto utilizado no negócio. - `shippingType` string — Tipo de frete selecionado para o negócio. - `status` string — Status atual do negócio. - `code` number — Código interno do negócio. - `externalId` string — ID externo vinculado ao negócio. - `lastMovedAt` string, date-time — Data da última movimentação do negócio. - `statusChangedAt` string, date-time — Data da última alteração do status do negócio. - `products` BusinessProductDto[] — Lista de produtos associados ao negócio. - `id` string — Identificador único do produto no negócio. - `product` ProductDto - `id` string — Id do produto - `id_sku` string — Id SKU do produto - `name` string — Nome do produto - `price` number — Preço do produto - `createdAt` string, date-time — Data de criação do produto - `quantity` number — Quantidade do produto no negócio. - `price` number — Preço unitário do produto no negócio. - `total` number — Valor total do produto no negócio (preço x quantidade). - `lossReasonId` string — ID do motivo de perda do negócio. - `justification` string — Justificativa associada ao negócio. - `productsCount` number — Quantidade total de produtos no negócio. - `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 - `activityType` ActivityTypeDto - `id` string — ID do tipo de atividade. - `name` string — Nome do tipo de atividade. - `color` string — Cor do tipo de atividade em formato hexadecimal - `required` boolean — Valor boneano que indica se a atividade é obrigatória ou não - `flow` FlowDto - `id` string — ID da automação. - `name` string — Nome da automação. - `description` string — Descrição da automação. - `createdAt` string, date-time — Data de criação da automação. - `updatedAt` string, date-time — Data da última atualização da automação. - `group` string — Grupo do fluxo. - `active` boolean — Valor booleano que indica se a automação está ativa. --- [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)