Introdução

Visão geral da API Colmeia para integrar a operação da sua empresa de serviço.

API da Colmeia

Integre a operação da sua empresa de serviço à Colmeia. A API v1 é REST, usa JSON e permite criar, consultar e conectar dados da sua operação.

O que você pode integrar

  • Clientes e oportunidades
  • Projetos e tarefas
  • Campanhas e atividades
  • WhatsApp
  • Webhooks de entrada

Base URL

https://app.usecolmeia.com/api/v1

Autenticação

Nos endpoints autenticados por chave, envie sua chave de API:

Authorization: Bearer ea_live_...

Veja como gerar, armazenar e rotacionar chaves em Autenticação.

Primeira requisição

Liste até dez clientes do time vinculado à sua chave:

curl -sS "https://app.usecolmeia.com/api/v1/clients?limit=10" \
  -H "Authorization: Bearer $COLMEIA_API_KEY"

Convenções essenciais

  • Isolamento por time: o time é derivado da chave de API; não envie team_id.
  • JSON: envie Content-Type: application/json em requisições com corpo e leia respostas JSON.
  • Paginação: listas usam page e limit; limit vai de 1 a 100 e o padrão é 20.
  • Datas: envie e trate datas no formato ISO 8601, como 2026-08-11T14:30:00Z.

Próximos passos