# Referência da API

> A referência completa e interativa de todos os endpoints da API do GS Engage, com console de teste.

- URL canônica: https://docs.growthstation.app/docs/api/referencia
- Idioma: pt-BR
- Última atualização: 2026-09-20T08:21:20.451Z
- Produto: GS Engage
- Mantido por: Product Education
- Revisão editorial: 2026-07-20



<PageHero emoji="📖" title="Referência da API" description="A lista completa de endpoints, com parâmetros, formatos de resposta e um console para testar na hora." gradient="brand" />

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.

<ApiReferenceLinks />

<Callout type="tip" title="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.
</Callout>

<Callout type="warning" title="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.
</Callout>

Onde cada coisa mora [#onde-cada-coisa-mora]

| Você quer…                               | Vá para                                                          |
| ---------------------------------------- | ---------------------------------------------------------------- |
| Entender o que dá para fazer e começar   | [Comece aqui](/docs/api/comece-aqui/o-que-da-pra-fazer)          |
| Um passo a passo por objetivo de negócio | [Guias por caso de uso](/docs/api/guias/adicionar-lead-cadencia) |
| Integrar sem programar                   | [Sem código](/docs/api/no-code/zapier)                           |
| Traduzir um termo técnico                | [Glossário](/docs/api/conceitos/glossario)                       |
| A lista exata de um endpoint             | **Referência da API** (links acima)                              |

Artigos Relacionados [#artigos-relacionados]

<RelatedArticles>
  <RelatedArticle href="/docs/api/comece-aqui/quickstart" title="Quickstart em 5 minutos" description="Da sua chave à primeira chamada bem-sucedida." />

  <RelatedArticle href="/docs/api/conceitos/autenticacao" title="Autenticação e segurança da apiKey" description="Como a chave funciona e como guardá-la com segurança." />
</RelatedArticles>