# Como realizar a integração via API com o GS Engage?

> Conecte o GS Engage a CRMs, ferramentas de marketing e sistemas de análise via API para automatizar a gestão de cadências, leads e prospecções.

- URL canônica: https://docs.growthstation.app/docs/integracoes/api
- Idioma: pt-BR
- Última atualização: 2026-08-17T12:49:19.121Z
- Produto: GS Engage
- Mantido por: Produto GS Engage



















<PageHero emoji="🔌" title="Integração via API com o GS Engage" description="Conecte o GS Engage a CRMs, ferramentas de marketing e sistemas de análise para automatizar a gestão de cadências, leads e prospecções." gradient="brand" />

A API do GS Engage permite a integração com outras plataformas para otimizar a gestão de cadências, leads e prospecções, possibilitando a automação de processos e o gerenciamento eficiente de dados.

🔌 O que é a API do GS Engage? [#-o-que-é-a-api-do-gs-engage]

A API do GS Engage é uma interface que permite a comunicação entre o GS Engage e outras plataformas, como CRMs, sistemas de automação de marketing e ferramentas de análise de dados. Com ela, é possível automatizar processos e otimizar a gestão de leads.

Por meio da API, é possível:

<FieldInfoGroup>
  <FieldInfo title="Iniciar leads">
    Automatizar o início do contato com um lead dentro da plataforma.
  </FieldInfo>

  <FieldInfo title="Criar leads">
    Adicionar novos leads ao GS Engage diretamente de outras ferramentas.
  </FieldInfo>

  <FieldInfo title="Extrair dados">
    Obter informações sobre leads, cadências e atividades realizadas para análise e integração com outros sistemas.
  </FieldInfo>
</FieldInfoGroup>

🔄 Como funciona a integração via API? [#-como-funciona-a-integração-via-api]

A API do GS Engage permite a comunicação entre o sistema e outras plataformas, como CRMs, sistemas de automação de marketing e ferramentas de análise de dados. Isso é feito por meio de chamadas HTTP que possibilitam o envio e recebimento de dados entre os sistemas.

🔑 Autenticação [#-autenticação]

<Callout type="info" title="Método apiKeyQuery">
  Para acessar a API, é utilizado o método de autenticação **apiKeyQuery**. Isso significa que é necessário incluir uma chave de API (API Key) em todas as requisições para autenticação.
</Callout>

🛠️ Como obter a sua chave API? [#️-como-obter-a-sua-chave-api]

Para obter sua chave API, siga os seguintes passos:

<Steps>
  <Step num={1} title="Acesse Ajustes e Permissões">
    Na navbar, clique no atalho <TextHighlight>Ajustes e Permissões</TextHighlight>.

        <img alt="Atalho Ajustes e Permissões na navbar do GS Engage" src={__img0} placeholder="blur" />
  </Step>

  <Step num={2} title="Abra Configurações de API">
    Selecione a seção de <TextHighlight>Configurações de API</TextHighlight>.

        <img alt="Seção Configurações de API nos ajustes do GS Engage" src={__img1} placeholder="blur" />
  </Step>

  <Step num={3} title="Crie uma nova chave">
    Clique no botão <TextHighlight>Criar chave</TextHighlight> para gerar uma nova chave API.

        <img alt="Botão Criar chave nas Configurações de API" src={__img2} placeholder="blur" />
  </Step>

  <Step num={4} title="Copie a chave">
    Copie a chave de API gerada.

        <img alt="Chave de API gerada pronta para ser copiada" src={__img3} placeholder="blur" />
  </Step>

  <Step num={5} title="Use a chave nas requisições">
    Inclua a chave de API copiada nas requisições da seguinte forma:

    ```
    GET /api/v1/leads?apiKey=SUA_CHAVE_DE_API
    ```
  </Step>
</Steps>

<Callout type="tip" title="Documentação técnica completa">
  Para saber mais sobre as requisições disponíveis, acesse a [Referência da API do GS Engage](/docs/api/referencia).
</Callout>

🔒 Dicas de segurança [#-dicas-de-segurança]

<Callout type="warning" title="Proteja sua chave de API">
  * **Proteja sua chave**: não compartilhe sua chave de API publicamente, nem a inclua em scripts ou URLs acessíveis publicamente.
  * **Exclusão de chave**: se houver suspeita de comprometimento da chave, exclua-a imediatamente e gere uma nova.
</Callout>

🧹 Como excluir sua chave API? [#-como-excluir-sua-chave-api]

Para excluir a chave API gerada, siga os seguintes passos:

<Steps>
  <Step num={1} title="Acesse Ajustes e Permissões">
    Na navbar, clique no atalho <TextHighlight>Ajustes e Permissões</TextHighlight>.

        <img alt="Atalho Ajustes e Permissões na navbar do GS Engage" src={__img4} placeholder="blur" />
  </Step>

  <Step num={2} title="Abra Configurações de API">
    Selecione a seção de <TextHighlight>Configurações de API</TextHighlight>.

        <img alt="Seção Configurações de API nos ajustes do GS Engage" src={__img5} placeholder="blur" />
  </Step>

  <Step num={3} title="Exclua a chave">
    Clique no botão <TextHighlight>Excluir chave de API</TextHighlight> para realizar a exclusão.

        <img alt="Botão Excluir chave de API nas Configurações de API" src={__img6} placeholder="blur" />
  </Step>

  <Step num={4} title="Confirme a exclusão">
    Confirme a exclusão da chave API clicando na opção <TextHighlight>Excluir chave de API</TextHighlight>.

        <img alt="Confirmação de exclusão da chave de API" src={__img7} placeholder="blur" />
  </Step>
</Steps>

💡 Casos de uso comuns [#-casos-de-uso-comuns]

<CardGrid cols={2}>
  <CardLink href="/docs/integracoes/pipedrive" icon="🔗" title="Integração com CRMs">
    A API do GS Engage pode ser integrada a sistemas de CRM, como o Pipedrive, permitindo que os leads capturados sejam automaticamente sincronizados. Isso garante que todas as informações estejam centralizadas e atualizadas em um único lugar.
  </CardLink>

  <CardLink href="/docs/integracoes/rd-marketing" icon="📢" title="Integração com Plataformas de Marketing">
    A API também possibilita a conexão com plataformas de automação de marketing, como o RD Station Marketing. Com isso, é possível criar campanhas personalizadas utilizando dados coletados de diferentes fontes.
  </CardLink>
</CardGrid>

🏷️ Como leads criados e iniciados via API são exibidos no GS Engage? [#️-como-leads-criados-e-iniciados-via-api-são-exibidos-no-gs-engage]

<FieldInfoGroup>
  <FieldInfo title="Painel de Atividades">
    Leads iniciados via API aparecem com a tag **Levantada de Mão** e são exibidos primeiro na listagem de atividades a serem realizadas.
  </FieldInfo>

  <FieldInfo title="Gerenciamento de Leads">
    Leads inseridos através da integração via API são exibidos como **Criado a partir da API**.
  </FieldInfo>
</FieldInfoGroup>

<Callout type="info" title="Ainda tem dúvida?">
  [Abra uma solicitação](/docs/configuracoes/tickets-de-suporte) para o nosso time.
</Callout>

<RelatedArticles>
  <RelatedArticle href="/docs/integracoes/webhook" title="Integração via Webhook" description="Receba notificações em tempo real sobre eventos do GS Engage e automatize fluxos de trabalho." />

  <RelatedArticle href="/docs/integracoes/zapier" title="Integrações via Zapier" description="Conecte o GS Engage a diversos sistemas usando o aplicativo Growth Station no Zapier." />

  <RelatedArticle href="/docs/integracoes/pipedrive" title="Integração com o CRM Pipedrive" description="Envie leads trabalhados no GS Engage para o Pipedrive de forma manual ou automática." />

  <RelatedArticle href="/docs/integracoes/rd-marketing" title="Integração com o RD Station Marketing" description="Sincronize automaticamente os leads capturados com o RD Station Marketing." />
</RelatedArticles>