API de Contatos

API de Contatos

Endpoints para criar, listar, atualizar e excluir contatos no Healthing CRM.

Listar Contatos

GET /api/v1/contacts

Parâmetros de Query

Parâmetro	Tipo	Descrição
page	integer	Número da página (padrão: 1)
per_page	integer	Itens por página (padrão: 20, máx: 100)
search	string	Busca por nome, email ou telefone
sort_by	string	Campo para ordenação
sort_order	string	asc ou desc

Resposta

{
  "items": [
    {
      "id": 1,
      "first_name": "João",
      "last_name": "Silva",
      "email": "joao@exemplo.com",
      "phone": "+5511999999999",
      "company_id": 1,
      "status": "active",
      "source": "website",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 150,
  "page": 1,
  "per_page": 20,
  "pages": 8
}

Exemplo

curl "https://crm.healthing.com.br/api/v1/contacts?page=1&per_page=10" \
  -H "Authorization: Bearer SEU_TOKEN"

---

Obter Contato

GET /api/v1/contacts/{id}

Resposta

{
  "id": 1,
  "first_name": "João",
  "last_name": "Silva",
  "email": "joao@exemplo.com",
  "phone": "+5511999999999",
  "company_id": 1,
  "company": {
    "id": 1,
    "name": "Empresa ABC"
  },
  "status": "active",
  "source": "website",
  "tags": ["cliente", "vip"],
  "custom_fields": {
    "cpf": "123.456.789-00",
    "data_nascimento": "1990-05-15"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

---

Criar Contato

POST /api/v1/contacts

Corpo da Requisição

{
  "first_name": "Maria",
  "last_name": "Santos",
  "email": "maria@exemplo.com",
  "phone": "+5511888888888",
  "company_id": 1,
  "source": "api",
  "tags": ["lead"],
  "custom_fields": {
    "cpf": "987.654.321-00"
  }
}

Resposta (201 Created)

{
  "id": 2,
  "first_name": "Maria",
  "last_name": "Santos",
  "email": "maria@exemplo.com",
  "phone": "+5511888888888",
  "status": "active",
  "created_at": "2024-01-16T14:00:00Z"
}

---

Atualizar Contato

PUT /api/v1/contacts/{id}

Corpo da Requisição

{
  "first_name": "Maria",
  "last_name": "Santos Silva",
  "status": "qualified"
}

Resposta

{
  "id": 2,
  "first_name": "Maria",
  "last_name": "Santos Silva",
  "status": "qualified",
  "updated_at": "2024-01-16T15:00:00Z"
}

---

Excluir Contato

DELETE /api/v1/contacts/{id}

Resposta (204 No Content)

Sem corpo de resposta.

---

Campos do Contato

Campo	Tipo	Obrigatório	Descrição
first_name	string	Sim	Primeiro nome
last_name	string	Não	Sobrenome
email	string	Não	E-mail (único)
phone	string	Não	Telefone (formato E.164)
company_id	integer	Não	ID da empresa associada
status	string	Não	Status do contato
source	string	Não	Origem do contato
tags	array	Não	Lista de tags
custom_fields	object	Não	Campos personalizados

Status Disponíveis

• active - Ativo
• inactive - Inativo
• qualified - Qualificado
• unqualified - Não qualificado

Fontes (Source)

• website - Site
• referral - Indicação
• social - Redes sociais
• ads - Anúncios
• api - Via API
• import - Importação
• manual - Cadastro manual