Versão 1.0.0
Referência da API
120 operações em 20 recursos, geradas do schema real da API — cada campo, cada restrição e cada código de erro sai do mesmo documento que a API valida.
Endereço basehttps://api.growthaisystem.com/api/v1
Recursos
- Contatos14
Pessoas e empresas do CRM: criar, atualizar, etiquetar, arquivar e ler.
- Funil17
Negócios, etapas, resumo e histórico de movimentação.
- Agenda9
Tipos de reunião, horários livres, agendamento, remarcação e desfecho.
- Tarefas5
Tarefas do time ligadas a um contato ou a um negócio.
- Interações1
Linha do tempo de mensagens, ligações, e-mails e notas.
- Conversas10
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
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
Campos personalizados e etiquetas: as chaves que as escritas aceitam.
- Plataforma2
Uso de aluno na plataforma Accelera (escopo
platform.read, exclusivo da conta da casa). - Cérebro5
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
Produtos e serviços que o negócio vende, com preço e condições (escopo
catalog.read). Só leitura. - Relatórios5
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
Formulários de coleta e as respostas recebidas (escopo
forms.read). Só leitura. - Social5
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
Resultados das campanhas do Meta Ads: resumo, campanha, públicos e criativos (escopo
ads.read). Só leitura. - Automações3
As automações do CRM e o histórico de execuções de cada uma (escopo
automations.read). Só leitura. - Ações2
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
Assinaturas de evento e histórico de entrega.
- Credencial1
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
Todas as operações
A lista inteira, na ordem do documento — útil para achar uma rota pelo caminho quando não se sabe em que recurso ela mora.
GET /contactsListar contatosPOST /contactsCriar contatoGET /contacts/contextContexto de vários contatos (lote)GET /contacts/{id}Buscar contato por idPATCH /contacts/{id}Atualizar contatoDELETE /contacts/{id}Arquivar contatoGET /contacts/{id}/contextContexto do contato para agente (pacote pronto)POST /contacts/upsertCriar ou atualizar contato (upsert)POST /contacts/{id}/tagsAdicionar ou remover etiquetasPOST /contacts/{id}/notesCriar nota no contatoGET /contacts/{id}/ai-summaryLer o Resumo (IA) do contatoPOST /contacts/{id}/ai-summaryGerar o Resumo (IA) do contatoGET /pipelinesListar funis com estágiosGET /opportunitiesListar negóciosPOST /opportunitiesCriar negócioGET /opportunities/summaryResumo do funil (contagem e soma por estágio e por status)GET /opportunities/{id}Buscar negócio por idPATCH /opportunities/{id}Atualizar negócioGET /opportunities/{id}/historyHistórico de estágio do negócioGET /opportunity-eventsListar eventos de estágio (todos os negócios)POST /opportunities/{id}/moveMover negócio de etapa (ou de funil)POST /opportunities/{id}/winMarcar negócio como ganhoPOST /opportunities/{id}/loseMarcar negócio como perdidoPOST /opportunities/{id}/reopenReabrir negócio ganho ou perdidoGET /opportunities/{id}/notesListar notas do negócioPOST /opportunities/{id}/notesCriar nota no negócioPATCH /notes/{id}Editar nota do negócioPOST /opportunities/{id}/attachmentsAnexar arquivo ao negócioPUT /opportunities/{id}/custom-fieldsEscrever campos personalizados do negócioGET /calendarsListar agendas (tipos de reunião)GET /calendars/{id}/slotsHorários livres de uma agendaGET /appointmentsListar reuniõesPOST /appointmentsAgendar reuniãoGET /appointments/{id}Buscar reunião por idGET /appointments/{id}/historyHistórico da reuniãoPATCH /appointments/{id}/rescheduleRemarcar reuniãoPOST /appointments/{id}/cancelCancelar reuniãoPOST /appointments/{id}/outcomeRegistrar desfecho da reuniãoGET /usersListar membros do workspaceGET /custom-fieldsListar campos personalizadosGET /tagsListar etiquetas do workspaceGET /tasksListar tarefasPOST /tasksCriar tarefaPATCH /tasks/{id}Editar tarefaPOST /tasks/{id}/completeConcluir tarefaPOST /tasks/{id}/reopenReabrir tarefaPOST /notificationsAvisar uma pessoa do timeGET /interactionsListar interações (linha do tempo global por período)GET /conversationsListar conversasPOST /conversationsIniciar conversa com um contatoGET /conversations/{id}Buscar conversa por idGET /conversations/{id}/messagesListar mensagens da conversaPOST /conversations/{id}/messagesResponder na conversaGET /conversations/{id}/messages/{messageId}/mediaBaixar a mídia de uma mensagemPOST /conversations/{id}/handoffPassar a conversa para humanoPOST /conversations/{id}/resumeRetomar a conversa (devolver ao agente)GET /whatsapp/templatesListar modelos aprovados do WhatsAppPOST /conversations/{id}/templateEnviar modelo do WhatsApp na conversaPOST /contacts/{id}/emailsEnviar e-mail ao contatoPOST /contacts/{id}/journeysInscrever contato numa jornadaPOST /contacts/{id}/presentations/sendReenviar a apresentação comercial ao contatoGET /platform/usersListar alunos com resumo de usoGET /platform/users/{id}Uso completo de um aluno (matrículas, aulas assistidas, certificados, login)GET /webhooksListar assinaturas de webhookPOST /webhooksCriar assinatura de webhookPATCH /webhooks/{id}Atualizar assinatura de webhookDELETE /webhooks/{id}Remover assinatura de webhookGET /webhooks/{id}/deliveriesÚltimas entregas de uma assinaturaGET /cerebro/contextoConsultar o Cérebro do negócioGET /cerebro/documentosListar documentos do CérebroGET /cerebro/documentos/{id}Ver um documento do CérebroPOST /cerebro/proposalsPropor conteúdo ao CérebroGET /cerebro/proposals/{id}Acompanhar uma proposta ao CérebroGET /chargesListar cobrançasPOST /chargesCriar cobrançaGET /charges/{id}Buscar cobrança por idGET /charges/{id}/installmentsParcelas de crédito da cobrançaGET /receivablesAgenda de recebíveisGET /payersListar pagadoresPOST /charges/{id}/refundEstornar cobrançaGET /payment-linksListar links de pagamentoPOST /payment-linksCriar link de pagamentoGET /balanceConsultar saldoGET /plansListar planosPOST /plansCriar planoGET /subscriptionsListar assinaturasPOST /subscriptionsCriar assinaturaGET /subscriptions/{id}Buscar assinatura por idPOST /subscriptions/{id}/pausePausar assinaturaPOST /subscriptions/{id}/resumeReativar assinaturaPOST /subscriptions/{id}/cancelCancelar assinaturaPOST /subscriptions/{id}/change-planTrocar plano da assinaturaGET /payoutsListar repassesGET /payouts/{id}Buscar repasse por idGET /disputesListar contestaçõesGET /disputes/{id}Buscar contestação por idGET /catalogListar produtos e serviçosGET /catalog/{id}Buscar item do catálogo por idGET /reports/funnelFunil de conversão por etapaGET /reports/pipeline-valueDinheiro na mesa por etapaGET /reports/monthly-salesVendas por mêsGET /reports/loss-reasonsMotivos de perdaGET /reports/activity-by-ownerDesempenho por responsávelGET /formsListar formuláriosGET /forms/{id}/responsesListar respostas de um formulárioGET /forms/{id}/responses/{responseId}Buscar resposta de formulário por idGET /social/accountsListar contas do planejador socialGET /social/postsListar posts do planejadorPOST /social/postsGuardar ideia de postGET /social/posts/{id}Buscar post do planejador por idGET /social/metricsNúmeros do planejador socialGET /ads/summaryResumo das campanhas do Meta AdsGET /ads/campaigns/{id}Uma campanha do Meta AdsGET /ads/segmentsDiagnóstico por público de uma campanhaGET /ads/creativesAnúncios de uma campanha por eficiênciaGET /automationsListar automaçõesGET /automations/{id}/runsHistórico de execuções de uma automaçãoGET /actionsListar as Ações desta chaveGET /actions/{id}Acompanhar uma AçãoGET /meQuem sou eu (credencial e escopos)