Referência da API
A referência completa e interativa de todos os endpoints da API do GS Engage, com console de teste.
Referência da API
A lista completa de endpoints, com parâmetros, formatos de resposta e um console para testar na hora.
Estes guias cobrem os casos de uso — o "como fazer" passo a passo. Quando você precisar da lista completa e exata de cada endpoint (todos os parâmetros, os campos de cada resposta, os códigos de erro), use a Referência da API: um portal técnico gerado direto do OpenAPI, sempre em dia com o comportamento real da API, e com um console "Testar" para disparar chamadas sem sair da página.
Todos os endpoints de Cadências, Leads, Prospecções, Campos Personalizados e Conversas — com console de teste.
Referência de Webhooks ↗O contrato completo dos eventos de webhook, payloads e envelope de entrega.
Antes de abrir a referência
O essencial para não se perder lá: a base é https://api.gsengage.com e toda chamada
leva sua chave na URL, no formato ?apiKey=SUA_CHAVE. Os detalhes de autenticação,
limites de uso e formatos de resposta estão explicados de forma amigável aqui nos guias.
O console faz chamadas reais
Não existe ambiente de teste (sandbox). Ao usar o botão Testar na referência, a requisição atinge dados de produção — prefira operações de leitura enquanto explora.
Onde cada coisa mora
| Você quer… | Vá para |
|---|---|
| Entender o que dá para fazer e começar | Comece aqui |
| Um passo a passo por objetivo de negócio | Guias por caso de uso |
| Integrar sem programar | Sem código |
| Traduzir um termo técnico | Glossário |
| A lista exata de um endpoint | Referência da API (links acima) |
Este artigo foi útil?
Catálogo de eventos de webhook
Conheça todos os eventos que o GS Engage envia por webhook, o formato de cada entrega e as boas práticas para recebê-los com segurança.
Playbook de integração para parceiros e agências
Um roteiro reutilizável para agências implantarem a API do GS Engage em vários clientes com o mesmo padrão de qualidade.