A referência completa, com cada campo de cada endpoint, fica na documentação oficial da plataforma (em inglês), linkada no fim. Esta página é a camada de cima: o que você quer fazer, qual chamada faz isso e qual escopo precisa.
Todas as chamadas usam a base https://services.leadconnectorhq.com e os headers Authorization: Bearer <token> e Version: 2021-07-28. O ID_DA_CONTA é o ID de localização do Perfil da empresa.
Contatos
| Tarefa | Chamada | Escopo |
|---|
| Listar | GET /contacts/?locationId=ID_DA_CONTA&limit=100 | contacts.readonly |
| Buscar com filtros | POST /contacts/search | contacts.readonly |
| Ler um | GET /contacts/{id} | contacts.readonly |
| Criar ou atualizar sem duplicar | POST /contacts/upsert | contacts.write |
| Criar | POST /contacts/ | contacts.write |
| Atualizar | PUT /contacts/{id} | contacts.write |
| Apagar | DELETE /contacts/{id} | contacts.write |
| Adicionar etiqueta | POST /contacts/{id}/tags | contacts.write |
| Listar etiquetas da conta | GET /locations/ID_DA_CONTA/tags | locations/tags.readonly |
| Listar campos personalizados | GET /locations/ID_DA_CONTA/customFields?model=contact | locations/customFields.readonly |
Oportunidades
| Tarefa | Chamada | Escopo |
|---|
| Listar pipelines e fases | GET /opportunities/pipelines?locationId=ID_DA_CONTA | opportunities.readonly |
| Buscar | GET /opportunities/search?location_id=ID_DA_CONTA&pipeline_id=... | opportunities.readonly |
| Criar | POST /opportunities/ | opportunities.write |
| Criar ou atualizar | POST /opportunities/upsert | opportunities.write |
| Atualizar | PUT /opportunities/{id} | opportunities.write |
| Ganho ou perdido | PUT /opportunities/{id}/status | opportunities.write |
Conversas
| Tarefa | Chamada | Escopo |
|---|
| Enviar mensagem | POST /conversations/messages com type WhatsApp, SMS ou Email | conversations/message.write |
| Listar conversas | GET /conversations/search?locationId=ID_DA_CONTA | conversations.readonly |
| Ler mensagens de uma conversa | GET /conversations/{id}/messages | conversations.readonly |
Calendário
| Tarefa | Chamada | Escopo |
|---|
| Listar calendários | GET /calendars/?locationId=ID_DA_CONTA | calendars.readonly |
| Horários livres | GET /calendars/{id}/free-slots?startDate=...&endDate=... | calendars.readonly |
| Marcar compromisso | POST /calendars/events/appointments | calendars/events.write |
| Cancelar ou alterar | PUT /calendars/events/appointments/{id} | calendars/events.write |
Conta
| Tarefa | Chamada | Escopo |
|---|
| Listar usuários | GET /users/?locationId=ID_DA_CONTA | users.readonly |
| Listar automações | GET /workflows/?locationId=ID_DA_CONTA | workflows.readonly |
Eventos
Receber evento no seu sistema não é endpoint, é a ação Webhook numa automação: Receber evento no seu sistema. Mandar evento pra cá é o gatilho de webhook de entrada: Receber lead de fora.
Referência completa
A documentação oficial de cada endpoint, com todos os campos, está em marketplace.gohighlevel.com/docs. É a fonte da plataforma que roda por baixo do all4sales, em inglês. Use a nossa página pra achar o caminho e a oficial pra conferir o campo.
