# API do Gritz Connect

> API HTTP/JSON do Gritz Connect (CRM e plataforma de atendimento omnichannel): conversas, contatos, funis de vendas, marketing, rastreamento de origem de leads e configuração da conta. Documentação em português (pt-BR).

- URL base: `https://hub.gritz.app`
- Autenticação: header `api_access_token: SEU_TOKEN`
- Cinco superfícies com credenciais distintas: Application API, Reports API, Client API, Platform API e ingestão pública.
- Documentação inteira em um arquivo: https://www.gritz.app/llms-full.txt

## Conceitos

- [Visão geral da API](https://www.gritz.app/docs/visao-geral.md): O Gritz Connect expõe uma API HTTP/JSON para tudo que o painel faz: atendimento (conversas, mensagens, caixas de entrada), CRM (funis, negócios, propostas), marketing, rastreamento de origem de leads e configuração da conta.
- [Autenticação](https://www.gritz.app/docs/autenticacao.md): Cada superfície de API tem sua própria credencial.
- [Erros e limites de uso](https://www.gritz.app/docs/erros-e-limites.md): O campo attributes diz quais campos falharam — use-o para marcar o formulário, em vez de fazer parse da string de message.
- [Paginação, filtros e busca](https://www.gritz.app/docs/paginacao-e-filtros.md): O tamanho de página é fixo por recurso (contatos, por exemplo, retornam 15 por página) — não há parâmetro per_page genérico.
- [Webhooks](https://www.gritz.app/docs/webhooks.md): Base URL: https://hub.gritz.app

## Atendimento

- [Contatos](https://www.gritz.app/docs/contatos.md): Um contato é a pessoa do outro lado da conversa: nome, e-mail, telefone(s), rótulos, atributos personalizados e o histórico dela na conta.
- [Conversas](https://www.gritz.app/docs/conversas.md): Uma conversa é a thread entre um contato e a sua equipe dentro de uma caixa de entrada (inbox).
- [Mensagens](https://www.gritz.app/docs/mensagens.md): Mensagens são o conteúdo de uma conversa: o que o contato mandou, o que a equipe respondeu, as notas internas que só o time enxerga e os eventos de sistema ("Fulano resolveu a conversa").
- [Caixas de entrada, canais e distribuição](https://www.gritz.app/docs/caixas-de-entrada.md): Uma caixa de entrada (inbox) é o canal por onde a conta recebe e responde mensagens — WhatsApp, e-mail, widget do site, Telegram, SMS, API genérica, entre outros.
- [Canais e integrações externas](https://www.gritz.app/docs/canais-e-integracoes.md): Conecta o Gritz Connect a canais de mensagem (WhatsApp oficial e não oficial), provedores de números virtuais (Salvy), redes sociais para prospecção e publicação (LinkedIn, Instagram, TikTok, Twitter/X), produtividade (Microsoft, Google, Google Workspace, Google Calendar, Notion), agenda (meetings, calendar_events) e inteligência de concorrência (Meta Ad Library).

## CRM e comercial

- [CRM — funis, negócios e tarefas](https://www.gritz.app/docs/crm-funis-e-negocios.md): Módulo de CRM do Gritz Connect: funis de venda ou acompanhamento organizados em etapas, os negócios (Deal) que percorrem essas etapas, as saídas que fecham um negócio, e as tarefas (com follow-up automático) que mantêm o time trabalhando cada negócio.
- [CRM comercial — produtos, propostas, contratos e pagamentos](https://www.gritz.app/docs/crm-produtos-propostas-pagamentos.md): Esta área é exclusiva do Gritz Connect.
- [Formulários, captura de leads e importação de dados](https://www.gritz.app/docs/formularios-e-captura-de-leads.md): 1.

## Marketing e dados

- [Marketing, campanhas e e-mail marketing](https://www.gritz.app/docs/marketing-e-campanhas.md): Esta área cobre três produtos distintos que moram sob o guarda-chuva "marketing": campanhas (disparo em massa por WhatsApp/SMS/widget, recurso nativo da plataforma), o módulo Marketing (agendador/kanban editorial de posts do Instagram) e e-mail marketing (remetente verificado, listas, templates e campanhas de e-mail com rastreamento de abertura/clique).
- [Rastreamento, atribuição e Meta CAPI](https://www.gritz.app/docs/rastreamento-e-atribuicao.md): Esta área cobre tudo que responde à pergunta "de onde veio esse lead, e o que a gente devolveu para a plataforma de anúncio".
- [Rastreamento — configuração e painel (API v2)](https://www.gritz.app/docs/rastreamento-configuracao-v2.md): Esta área cobre a configuração e o painel do módulo de Rastreamento: os recursos que o cliente mexe para ligar a captura, e as telas que respondem "está tudo funcionando?".
- [Relatórios e Analytics](https://www.gritz.app/docs/relatorios.md): Métricas de conversas, agentes, inboxes, labels e times; relatórios personalizados (CSAT/SLA/conversas/contatos sob medida); dashboards em tempo real; analytics de UTM, CRM comercial e uso de IA.

## Automação e IA

- [Automações, produtividade e configurações da conta](https://www.gritz.app/docs/automacoes-e-produtividade.md): Recursos que automatizam o atendimento (regras de automação, macros, respostas prontas), organizam o trabalho da equipe (labels, atributos customizados, filtros salvos) e mantêm o agente informado (notificações) ou medem o uso dos fluxos automatizados (dashboard de automação).
- [IA e agentes](https://www.gritz.app/docs/ia-e-agentes.md): Área de inteligência artificial do Gritz Connect: o Admiral (motor de agentes de IA que atendem conversas), o Pergunte à IA (assistente pessoal do usuário do dashboard), o sistema de skills (automações event/cron que analisam conversas e sugerem ações) e os cubos (moeda interna que paga o consumo de IA).

## Conta e plataforma

- [Conta, perfil e autenticação](https://www.gritz.app/docs/conta-e-perfil.md): Como obter e rotacionar o token de API, gerenciar o perfil do usuário logado (disponibilidade, avatar, MFA), a conta em si (/api/v1/accounts/{id}) e as inscrições de notificação push.
- [Agentes, times e permissões](https://www.gritz.app/docs/agentes-times-permissoes.md): Gerencia quem atende: convite e edição de agentes, desligamento com redistribuição de carteira, times (filas de atendimento), papéis (administrator vs agent) e as permissões granulares dos custom roles.
- [Integrações, webhooks e central de ajuda](https://www.gritz.app/docs/integracoes-e-central-de-ajuda.md): Integrações com apps de terceiros (Slack, Shopify, Linear, Notion, Dialogflow, NAIA), o webhook de saída da conta, os "dashboard apps" (atalhos de app externo no menu do dashboard), a central de ajuda (portais, categorias e artigos) e a Academy (trilha de aprendizado do produto).
- [Platform API](https://www.gritz.app/docs/platform-api.md): A Platform API é a camada de provisionamento do Gritz Connect.
- [Client API](https://www.gritz.app/docs/client-api.md): A Client API é a API que você usa para falar em nome do cliente final.
- [Widget API](https://www.gritz.app/docs/widget-api.md): Esta é a API que o balão de chat do Gritz Connect usa por baixo dos panos: é ela que carrega a configuração do widget, cria o contato anônimo do visitante, abre a conversa e troca mensagens.

## Referência completa

- [Inventário de rotas](https://www.gritz.app/docs/inventario-de-rotas.md): Lista gerada a partir das rotas da aplicação — é a referência completa do que existe.