Contatos

CRUD completo para gerenciamento de contatos e leads.

GET /api/contacts Auth

Listar Contatos

Retorna a lista paginada de contatos do usuário. Suporta busca por nome ou email.

Query Parameters

page integer

Número da página (padrão: 1)

limit integer

Itens por página (padrão: 20, máx: 100)

search string

Busca por nome ou email

Status Codes

200 Lista retornada com sucesso

401 Não autenticado

Response

{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Maria Santos",
      "email": "maria@empresa.com",
      "phone": "+5511987654321",
      "position": "Diretora Comercial",
      "companyId": "507f1f77bcf86cd799439022",
      "tags": ["vip", "recorrente"],
      "notes": "Prefere contato por WhatsApp",
      "createdAt": "2026-03-10T14:20:00Z",
      "updatedAt": "2026-04-01T09:15:00Z"
    }
  ],
  "total": 142,
  "page": 1,
  "limit": 20
}

POST /api/contacts Auth

Criar Contato

Cria um novo contato vinculado ao usuário autenticado.

Request Body

name string obrigatório

Nome completo do contato

email string opcional

Email do contato

phone string opcional

Telefone com DDD (+5511...)

position string opcional

Cargo ou função

notes string opcional

Observações livres

Status Codes

201 Criado com sucesso

400 Dados inválidos

401 Não autenticado

Request

{
  "name": "Maria Santos",
  "email": "maria@empresa.com",
  "phone": "+5511987654321",
  "position": "Diretora Comercial",
  "notes": "Prefere contato por WhatsApp"
}

Response

{
  "id": "507f1f77bcf86cd799439011",
  "name": "Maria Santos",
  "email": "maria@empresa.com",
  "phone": "+5511987654321",
  "position": "Diretora Comercial",
  "notes": "Prefere contato por WhatsApp",
  "tags": [],
  "createdAt": "2026-05-07T10:00:00Z",
  "updatedAt": "2026-05-07T10:00:00Z"
}

GET /api/contacts/:id Auth

Buscar Contato por ID

Retorna os dados completos de um contato específico. Apenas o proprietário pode visualizar.

Status Codes

200 Registro encontrado

401 Não autenticado

403 Sem permissão (não é o proprietário)

404 Não encontrado

Response

{
  "id": "507f1f77bcf86cd799439011",
  "name": "Maria Santos",
  "email": "maria@empresa.com",
  "phone": "+5511987654321",
  "position": "Diretora Comercial",
  "companyId": "507f1f77bcf86cd799439022",
  "tags": ["vip"],
  "notes": "Prefere contato por WhatsApp",
  "createdAt": "2026-03-10T14:20:00Z",
  "updatedAt": "2026-04-01T09:15:00Z"
}

PUT /api/contacts/:id Auth

Atualizar Contato

Atualiza os dados de um contato existente. Envie apenas os campos que deseja modificar.

Request Body

name string opcional

Nome completo

email string opcional

phone string opcional

Telefone

position string opcional

Cargo

notes string opcional

Observações

Status Codes

200 Atualizado com sucesso

400 Dados inválidos

401 Não autenticado

403 Sem permissão (não é o proprietário)

404 Não encontrado

Request

{
  "position": "CEO",
  "notes": "Promovida em maio/2026"
}

Response

{
  "id": "507f1f77bcf86cd799439011",
  "name": "Maria Santos",
  "email": "maria@empresa.com",
  "position": "CEO",
  "notes": "Promovida em maio/2026",
  "updatedAt": "2026-05-07T15:30:00Z"
}

DELETE /api/contacts/:id Auth

Remover Contato

Remove permanentemente um contato. Esta ação não pode ser desfeita.

Status Codes

200 Removido com sucesso

401 Não autenticado

403 Sem permissão (não é o proprietário)

404 Não encontrado

Response

{
  "message": "Contact deleted successfully"
}