Atividades

Registro de atividades e timeline de interações com contatos e negócios.

POST /api/activities Auth

Registrar Atividade

Registra uma nova atividade vinculada a um contato, empresa ou negócio.

Request Body

type string obrigatório

Tipo: call, email, meeting, note, task

description string obrigatório

Descrição da atividade

relatedTo string obrigatório

ID da entidade relacionada (contato, empresa ou negócio)

relatedType string obrigatório

Tipo da entidade: contact, company, deal

metadata object opcional

Dados adicionais livres (ex: duração da ligação)

Status Codes

201 Criado com sucesso
400 Dados inválidos
401 Não autenticado
Request
{
  "type": "call",
  "description": "Ligação para alinhar proposta comercial",
  "relatedTo": "507f1f77bcf86cd799439011",
  "relatedType": "contact",
  "metadata": { "duration": "15min" }
}
Response
{
  "id": "507f1f77bcf86cd799439111",
  "type": "call",
  "description": "Ligação para alinhar proposta comercial",
  "relatedTo": "507f1f77bcf86cd799439011",
  "relatedType": "contact",
  "metadata": { "duration": "15min" },
  "createdBy": "507f1f77bcf86cd799439001",
  "createdAt": "2026-05-07T10:00:00Z"
}
GET /api/activities/recent Auth

Atividades Recentes

Retorna as atividades mais recentes do usuário autenticado.

Query Parameters

limit integer

Quantidade de atividades (padrão: 10, máx: 100)

Status Codes

200 Lista retornada com sucesso
401 Não autenticado
Response
{
  "data": [
    {
      "id": "507f1f77bcf86cd799439111",
      "type": "call",
      "description": "Ligação para alinhar proposta",
      "relatedTo": "507f1f77bcf86cd799439011",
      "relatedType": "contact",
      "createdAt": "2026-05-07T10:00:00Z"
    }
  ]
}
GET /api/activities/entity/:entityId Auth

Atividades por Entidade

Retorna todas as atividades vinculadas a um contato, empresa ou negócio específico.

Query Parameters

page integer

Número da página

limit integer

Itens por página (máx: 100)

Status Codes

200 Lista retornada com sucesso
401 Não autenticado
Response
{
  "data": [
    {
      "id": "507f1f77bcf86cd799439111",
      "type": "call",
      "description": "Ligação comercial",
      "relatedTo": "507f1f77bcf86cd799439011",
      "relatedType": "contact",
      "createdAt": "2026-05-07T10:00:00Z"
    }
  ],
  "total": 8,
  "page": 1,
  "limit": 20
}

Este site utiliza cookies

Utilizamos cookies essenciais para o funcionamento da plataforma e cookies de análise para melhorar sua experiência. Ao continuar navegando, você concorda com nossa Política de Privacidade e Termos de Uso.