A API pública tem 212 endpoints organizados em 28 recursos. Esta página é o índice. Use-a para descobrir onde está o que você precisa, e clique no nome do recurso para abrir o endpoint, com parâmetros, corpo, respostas e um playground para testar com a sua chave.
Os caminhos base não seguem um padrão único de nome. Há /v1/contatodechat, /v1/produto no singular e /v1/message em inglês. São nomes herdados de versões anteriores, mantidos para não quebrar integrações que já rodam. Copie o caminho da página do endpoint em vez de deduzi-lo.

​
Atendimento e mensagens

Atendimentos é o segundo maior recurso da API, atrás só de pipelines. Fora o CRUD da conversa, ele expõe as mensagens dela em /v1/atendimento/{idAtendimento}/mensagens, com criação, edição, exclusão e reenvio. Os guias de tela correspondentes são caixa de entrada e conversas.

​
Contatos e pessoas

Contato e pessoa são coisas diferentes. O contato é um ponto de contato, como um número de WhatsApp ou um perfil de Instagram. A pessoa é o cadastro que reúne vários contatos. O campo IdPessoa no contato faz o vínculo. Veja contatos e pessoas.
Para sincronizar contatos de outro sistema, use PUT /v1/contatodechat: ele localiza o contato pelo telefone e atualiza, sem precisar do Id. Se o telefone não existir na base, a resposta é 404, e aí você cria com POST. São duas chamadas no pior caso, e nenhuma delas duplica registro.

​
Funil de vendas

Pipelines concentra 47 endpoints porque tudo do funil fica aninhado sob ele:
Dois atalhos poupam trabalho aqui. GET /v1/pipelines/{idPipeline}/negocios/contatos-disponiveis lista contatos que ainda não estão no funil, e POST /v1/pipelines/{idPipeline}/negocios/mover-em-massa move vários negócios de etapa em uma chamada só. Veja funis e negócios.

​
Help desk

Tickets não têm criação pela API: eles nascem na plataforma, por e-mail ou por automação. Pela API você consulta, altera com PATCH /v1/ticket/{idTicket} e inclui interações com POST /v1/ticket/IncluirInteracao. Veja tickets.

​
Agenda

Veja agenda e reuniões. Produtos é um dos dois recursos com PATCH, o que o torna o caminho natural para sincronizar preço e estoque de um ERP sem reenviar o cadastro inteiro. Veja produtos.

​
Vendas e pagamentos

A solicitação de pagamento nasce com status Pendente. A confirmação vem do gateway depois, e você a lê no Status da venda. Veja cobranças e loja e pedidos.

​
Configuração da conta

Os dados cadastrais dos usuários são somente leitura. Criar e desativar usuário se faz na plataforma, em usuários e permissões. O que a API escreve são os atributos do usuário, um espaço livre de chave e valor que serve bem para guardar o identificador dele no seu sistema:
Variáveis globais aceitam upsert pelo nome, com PUT /v1/variaveis-globais/nome/{nome}, que cria se não existir e atualiza se existir. É a forma mais simples de a sua integração guardar estado do lado do Novus CRM, sem precisar de tabela própria.