A API do Growth OS, documentada de ponta a ponta.
Contatos, funil, agenda, tarefas, equipe e webhooks do seu workspace — 120 operações em 20 recursos, com escopo mínimo por chave e auditoria por chamada. Cada campo desta documentação sai do mesmo schema que a API valida.
https://api.staging.growthaisystem.com/api/v1Primeiros 30 segundos
Faça sua primeira chamada
Crie uma chave em Acessos → Integrações e leia seus contatos. A resposta vem paginada por cursor, como todas as listagens.
curl "https://api.staging.growthaisystem.com/api/v1/contacts" \
-H "Authorization: Bearer gos_SEU_TOKEN_AQUI"- 1.A chave começa com
gos_e só aparece uma vez. - 2.Ela vai no cabeçalho
Authorization: Bearer …. - 3.Siga o
nextCursoraté ele virnull.
Recursos
Ver as 120 operações →- Contatos14 operações
Pessoas e empresas do CRM: criar, atualizar, etiquetar, arquivar e ler.
- Funil17 operações
Negócios, etapas, resumo e histórico de movimentação.
- Agenda9 operações
Tipos de reunião, horários livres, agendamento, remarcação e desfecho.
- Tarefas5 operações
Tarefas do time ligadas a um contato ou a um negócio.
- Interações1 operações
Linha do tempo de mensagens, ligações, e-mails e notas.
- Conversas10 operações
Conversas do Atendimento para um agente externo: ler a conversa e as mensagens, responder e passar para humano (escopos
conversations.read/conversations.write). Saída ativa — iniciar conversa com um contato e mandar modelo do WhatsApp fora da janela de 24h — pede tambémconversations.outbound. - Equipe2 operações
Membros do workspace — inclusive os desativados, para resolver nomes antigos — e o aviso no sino de uma pessoa do time (escopo
notifications.write). - Listas de apoio2 operações
Campos personalizados e etiquetas: as chaves que as escritas aceitam.
- Plataforma2 operações
Uso de aluno na plataforma Accelera (escopo
platform.read, exclusivo da conta da casa). - Cérebro5 operações
O conhecimento aprovado do negócio (escopo
cerebro.read): contexto para agentes e documentos vigentes. Propor conteúdo (escopocerebro.propose): a proposta fica pendente até uma pessoa aprovar. - Catálogo2 operações
Produtos e serviços que o negócio vende, com preço e condições (escopo
catalog.read). Só leitura. - Relatórios5 operações
Os relatórios prontos do CRM: funil, dinheiro na mesa, vendas por mês, motivos de perda e desempenho do time (escopo
reports.read). Só leitura. - Formulários3 operações
Formulários de coleta e as respostas recebidas (escopo
forms.read). Só leitura. - Social5 operações
O planejador social: contas conectadas, posts e números (escopo
social.read), e guardar ideias de post na gaveta de Ideias (escoposocial.write— nunca agenda nem publica). - Anúncios4 operações
Resultados das campanhas do Meta Ads: resumo, campanha, públicos e criativos (escopo
ads.read). Só leitura. - Automações3 operações
As automações do CRM e o histórico de execuções de cada uma (escopo
automations.read). Só leitura. - Ações2 operações
Acompanhar as Ações que a própria chave pediu (escopo
actions.read). Uma escrita de funcionário digital que precisa da aprovação do dono responde202comLocation: /api/v1/actions/{id}; esta é a rota para saber o desfecho. - Webhooks5 operações
Assinaturas de evento e histórico de entrega.
- Credencial1 operações
Quem é a credencial da chamada (a chave
gos_ou a pessoa do login OAuth), de qual workspace, e quais escopos ela tem. Não exige escopo: qualquer credencial válida pergunta. - Pagamentos23 operações
Guias
Na ordem que evita retrabalho: primeiro a chamada que funciona, depois as regras que valem em toda rota, e por fim o que mantém a integração rodando sozinha.
- ComeçandoCrie a chave, faça a primeira leitura, faça a primeira escrita — e saiba onde o resto mora.
- AutenticaçãoBearer token, os 10 escopos, allowlist de IP, os 60 segundos de propagação e o 429 que substitui o 401.
- Login de usuário (OAuth2)Quando o seu app entra com a conta da pessoa: OAuth2 com PKCE, a escolha do workspace e o token de 1 hora.
- ConvençõesDatas, telefone, e-mail, dinheiro, campos personalizados e a regra de null vs ausente no PATCH.
- Paginação e datasCursor opaco, ordem e teto por rota, as listas que não paginam e como sincronizar sem perder registro.
- ErrosUm envelope só, sempre — code, message e request_id. Aqui estão os 14 codes, com o que fazer em cada um.
- IdempotênciaA API deduplica escrita repetida em 60 segundos mesmo sem header — e o Idempotency-Key é a camada que você controla.
- Limites de usoQuatro baldes independentes — e os headers X-RateLimit-* descrevem só um deles.
- WebhooksAssine eventos, valide a assinatura HMAC, saiba o que garantimos na entrega — e o que não dispara webhook nenhum.
- PagamentosCobre por Pix, cartão (1 a 12x com 3DS) ou débito à vista, publique links de pagamento, crie assinaturas mensais, estorne (integral ou parcial), consulte o saldo, os repasses e as contestações pela API, com eventos charge.* e subscription.* no seu webhook.