Referência ao endpoint do serviço

Todos os caminhos nesta página são relativos a:

https://api.champrep.com

Utilize uma credencial de portador com escopo, conforme descrito em autenticação e APIchaves. Uma rota listada ainda está sujeita à disponibilidade atual do serviço, às configurações do plano e da organização, às permissões de função, ao acesso aos recursos e aos controles de uso em tempo real.

Mapa de serviços

Área	Prefixo	Âmbitos
Identidade e perfil	/v1/auth, /v1/users	users:read e contexto de credenciais
Pesquise em todos os serviços	/v1/search	O escopo de leitura de cada serviço pesquisado
Drive	/v1/drive	drive:read, drive:write, drive:delete
Chat	/v1/chat	chat:read, chat:write
Calendar	/v1/calendar	calendar:read, calendar:write
Contacts	/v1/contacts	contacts:read, contacts:write
Meet	/v1/meet	meet:read, meet:write
Notes	/v1/notes	notes:read, notes:write
Learn	/v1/learn, /v1/courses	courses:read, courses:write
CHAMPREP AI	/v1/ai	ai:chat
Mail	/v1/mail	mail:read, mail:write, mail:send
Work	/v1/work	work:read, work:write, work:delete
Org Chart	/v1/charts	charts:read, charts:write, charts:delete
Forms	/v1/forms	forms:read, forms:write
Invoice	/v1/invoice	invoice:read, invoice:write, invoice:send, invoice:delete
CHAMPREP QA	/v1/qa	qa:read, qa:write
CHAMPREP Business	/v1/business	business:read, business:manage
Faturamento	/v1/billing	billing:read, billing:manage
Webhooks	/v1/webhooks	webhooks:manage

GET, HEAD, e OPTIONS normalmente exigem o escopo de leitura. Os métodos de criação, atualização e ação exigem o escopo de gravação ou gerenciamento. Os métodos de exclusão exigem um escopo de exclusão, caso o serviço o defina. Uma rota pode exigir permissões adicionais de função ou recurso no serviço de destino.

Status de identidade e do gateway

Método	Caminho	Objetivo
GET	/v1/version	Retornar informações sobre a versão pública do Gateway.
GET	/v1/auth/whoami	Retornar o contexto do usuário ativo, do perfil, das credenciais e do plano.
GET	/v1/auth/quota	Retornar a chave atual e o instantâneo da cota do Gateway.
GET	/v1/users/me	Retornar o perfil do usuário atual.
GET	/v1/users/me/notifications	Listar as notificações visíveis ao usuário atual.

A trocaCLI assistida pelo navegador também utiliza /v1/auth/cli/start, /v1/auth/cli/device, e /v1/auth/cli/poll. Essas rotas são implementadas pelo aplicativo oficialCLI; aplicativos personalizados não devem imitar o protocolo de aprovaçãoCLI quando uma chaveAPI atender às suas necessidades.

Pesquise em todos os serviços

Método	Caminho	Escopo	Objetivo
GET	/v1/search	Por serviço, veja abaixo	Pesquise todos os serviços aos quais esta credencial tem acesso, em uma única chamada.
GET	/v1/search/services	Nenhum	Liste quais serviços esta credencial é capaz de pesquisar.

/v1/search distribui a solicitação pelos serviços que suportam a pesquisa e mescla os resultados. Parâmetros:

Parâmetro	Padrão	Objetivo
q	obrigatório	O termo de pesquisa.
limit	5	Número máximo de resultados por serviço, até 20.
services	todos	Lista separada por vírgulas, por exemplo mail,drive. Isso reduz a dispersão.
semantic	false	Definir true para reclassificar os resultados com IA e obter uma resposta breve. Gasta seus próprios créditos de IA.

Pesquisa inteligente com IA

semantic=true adiciona uma verificação de IA aos resultados que você já possui: ela analisa sua pergunta, reordena as correspondências de acordo com a qualidade da resposta, acrescenta uma breve justificativa a cada uma e retorna um parágrafo answer.

O serviço é pago com seus próprios créditos de IA — a mesma cota mensal que o CHAMPREP AIassistente utiliza. Nada é cobrado a menos que você solicite, e a pesquisa por palavra-chave nunca consome créditos de IA.

Cada resposta informa o que ocorreu em semantic:

"semantic": { "requested": true, "applied": true, "answer": "..." }

Quando a verificação de IA não puder ser executada, os resultados das palavras-chave serão exibidos sem alterações e semantic explica o motivo:

reason	Significado
AI_CREDITS_EXHAUSTED	Você esgotou seus créditos mensais de IA.
PLAN_NO_AI	Seu plano não inclui o serviço de IA.
AI_UNAVAILABLE	Não foi possível acessar o serviço de IA neste momento.

Uma tentativa de IA malsucedida nunca impede a pesquisa. Ligue /v1/search/services primeiro para verificar se a pesquisa inteligente está disponível — ela retorna semantic.available além dos seus créditos restantes — e oculte a opção de IA quando ela não estiver disponível.

Um serviço só é incluído quando a credencial possui permissão de leitura para ele (mail:read, drive:read, notes:read, calendar:read, chat:read, work:read, invoice:read, contacts:read) e o plano ativo permite isso. Ambas as verificações falham em modo “fechado”, portanto, um serviço que você não pode usar nunca contribui com resultados.

Chat As mensagens são criptografadas em repouso e são pesquisadas apenas dentro das salas das quais você faz parte, no histórico recente, em vez de no arquivo completo.

curl -H "Authorization: Bearer $CHAMPREP_API_KEY" \
  "https://api.champrep.com/v1/search?q=roadmap&services=mail,notes&limit=3"

Os resultados são agrupados por serviço e normalizados para um único formato, de modo que um cliente renderize todos os serviços da mesma maneira:

{
  "success": true,
  "data": {
    "query": "roadmap",
    "groups": [
      {
        "service": "notes",
        "label": "Notes",
        "results": [
          { "id": "6650...", "title": "Q3 roadmap", "subtitle": "Planning notes for...", "timestamp": "2026-08-02T10:14:00Z" }
        ]
      }
    ],
    "totalResults": 1,
    "searched": ["notes", "mail"],
    "skipped": [{ "service": "drive", "reason": "INSUFFICIENT_SCOPE" }],
    "cost": 2
  }
}

Leia skipped antes de tratar um resultado vazio como “nada encontrado”. Cada entrada explica por que um serviço foi deixado de fora — INSUFFICIENT_SCOPE, NOT_IN_PLAN, ou SERVICE_UNAVAILABLE quando um back-end estava muito lento ou temporariamente indisponível. Um serviço indisponível nunca faz com que toda a consulta falhe; o restante dos resultados ainda é retornado.

Quanto custa uma pesquisa

Uma pesquisa acessa um serviço por grupo de resultados, portanto é cobrada dessa forma: uma unidade de limite de taxa por serviço efetivamente pesquisado. O cost O campo em cada resposta informa exatamente o que foi cobrado e X-RateLimit-Remaining reflete isso antes de você receber a resposta.

Solicitação	Serviços pesquisados	Custo
?q=roadmap em um plano com todos os oito	8	8
?q=roadmap&services=mail	1	1
?q=roadmap em um plano com apenas Notes	1	1

Você nunca é cobrado por um serviço que não pode utilizar; portanto, restringir a pesquisa com services é a maneira mais econômica de manter uma pesquisa interativa ágil. Sempre aplique o debounce — nunca envie uma solicitação a cada tecla pressionada.

Drive

Método	Caminho	Escopo	Objetivo
GET	/v1/drive/files	drive:read	Listar ou pesquisar arquivos. Utilize o search Consulte quando necessário.
GET	/v1/drive/folders	drive:read	Listar o conteúdo da pasta raiz.
GET	/v1/drive/folders/{folderId}	drive:read	Listar o conteúdo de uma pasta.
GET	/v1/drive/starred	drive:read	Listar itens marcados com estrela.
GET	/v1/drive/recent	drive:read	Listar itens recentes.
GET	/v1/drive/shared	drive:read	Listar itens compartilhados.
GET	/v1/drive/quota	drive:read	Retornar o uso atual do armazenamento e a disponibilidade.
POST	/v1/drive/upload	drive:write	Criar um destino de upload.
POST	/v1/drive/files	drive:write	Salvar os metadados do arquivo após o upload ser concluído com sucesso.
POST	/v1/drive/download	drive:read	Criar um destino de download.
POST	/v1/drive/folders	drive:write	Criar uma pasta.
POST	/v1/drive/rename	drive:write	Mover ou renomear um item.
POST	/v1/drive/delete	drive:delete	Excluir um ou mais itens.
DELETE	/v1/drive/files/{fileId}	drive:delete	Excluir um arquivo por meio do método legado de item único.

O upload é uma operação em várias etapas: solicitar um destino de upload, transferir os bytes para esse destino e salvar os metadados resultantes. Utilize o método oficial ouSDK CLI quando não for necessário implementar essa sequência por conta própria.

Chat

Método	Caminho	Escopo	Objetivo
GET	/v1/chat/rooms	chat:read	Listar salas visíveis para o perfil ativo.
GET	/v1/chat/rooms/{roomId}	chat:read	Ler uma sala.
POST	/v1/chat/rooms	chat:write	Criar uma sala.
GET	/v1/chat/rooms/{roomId}/messages	chat:read	Listar mensagens da sala.
POST	/v1/chat/rooms/{roomId}/messages	chat:write	Enviar uma mensagem para a sala.
GET	/v1/chat/messages/search	chat:read	Pesquisar mensagens.
GET	/v1/chat/unread	chat:read	Retornar contagens de itens não lidos.
GET	/v1/chat/favorites	chat:read	Listar mensagens favoritas.

Calendar

Método	Caminho	Escopo	Objetivo
GET	/v1/calendar/events	calendar:read	Listar eventos; suporta startDate e endDate consultas.
GET	/v1/calendar/events/{eventId}	calendar:read	Ler um evento.
POST	/v1/calendar/events	calendar:write	Criar um evento.
PATCH	/v1/calendar/events/{eventId}	calendar:write	Atualizar um evento.
DELETE	/v1/calendar/events/{eventId}	calendar:write	Excluir um evento.
GET	/v1/calendar/upcoming	calendar:read	Listar reuniões futuras.
GET	/v1/calendar/invitations	calendar:read	Listar convites pendentes.

Envie carimbos de data/hora de eventos no formato ISO 8601 com um fuso horário explícito. A criação e as atualizações de eventos consomem a cota configurada para o plano ativo e a organização; o APInão define um limite fixo universal para o plano.

Contacts

Método	Caminho	Escopo	Objetivo
GET	/v1/contacts	contacts:read	Listar contatos.
GET	/v1/contacts/search	contacts:read	Pesquisar contatos com q ou email.
GET	/v1/contacts/favorites	contacts:read	Listar favoritos.
GET	/v1/contacts/labels	contacts:read	Listar rótulos.
GET	/v1/contacts/{contactId}	contacts:read	Ler um contato.
POST	/v1/contacts	contacts:write	Adicionar um contato.
PUT	/v1/contacts/{contactId}	contacts:write	Atualizar os metadados de contato.
DELETE	/v1/contacts/{contactId}	contacts:write	Excluir um contato.

Meet

Método	Caminho	Escopo	Objetivo
GET	/v1/meet/rooms	meet:read	Listar salas de reunião.
GET	/v1/meet/rooms/{roomId}	meet:read	Ler uma sala.
POST	/v1/meet/rooms	meet:write	Criar uma sala.
GET	/v1/meet/sessions	meet:read	Listar sessões de reunião.
GET	/v1/meet/sessions/{sessionId}/participants	meet:read	Listar os participantes da sessão.
GET	/v1/meet/recordings	meet:read	Listar as gravações disponíveis.
GET	/v1/meet/transcriptions	meet:read	Listar transcrições.
GET	/v1/meet/transcriptions/{sessionId}	meet:read	Ler a transcrição de uma sessão final.
GET	/v1/meet/usage	meet:read	Retornar o uso atual da reunião.

O acesso a gravações e transcrições depende da propriedade da reunião, do consentimento, da retenção, do plano e da política da organização.

Notes

Método	Caminho	Escopo	Objetivo
GET	/v1/notes	notes:read	Listar notas.
GET	/v1/notes/shared	notes:read	Listar notas compartilhadas com o perfil ativo.
GET	/v1/notes/{noteId}	notes:read	Ler uma nota.
POST	/v1/notes	notes:write	Criar uma nota.
PATCH	/v1/notes/{noteId}	notes:write	Atualizar uma nota.
DELETE	/v1/notes/{noteId}	notes:write	Excluir uma nota.
POST	/v1/notes/{noteId}/share	notes:write	Compartilhar uma nota utilizando as configurações de acesso compatíveis.

Learn e cursos

/v1/learn e /v1/courses expor as mesmas rotas de cursos selecionadas.

Método	Caminho	Escopo	Objetivo
GET	/v1/learn	courses:read	Listar os cursos disponíveis.
GET	/v1/learn/enrolled/my	courses:read	Listar as matrículas do usuário ativo.
GET	/v1/learn/{courseId}	courses:read	Ler um curso.
GET	/v1/learn/{courseId}/sections	courses:read	Listar seções do curso.
POST	/v1/learn	courses:write	Criar um curso quando a função o permitir.
PUT	/v1/learn/{courseId}	courses:write	Atualize um curso quando a função permitir.

Utilize o /v1/courses prefixo ao manter uma integração que já utilize esse alias.

CHAMPREP AI

Método	Caminho	Escopo	Objetivo
POST	/v1/ai/chat	ai:chat	Envie um prompt ou uma carga útil de conversa compatível.
GET	/v1/ai/conversations	ai:chat	Listar conversas salvas.
GET	/v1/ai/conversations/{conversationId}	ai:chat	Ler uma conversa.
DELETE	/v1/ai/conversations/{conversationId}	ai:chat	Excluir uma conversa.
GET	/v1/ai/usage	ai:chat	Retornar o uso atual de IA.

A saída da IA pode estar incompleta ou incorreta. Revise as saídas importantes e não envie dados que o usuário ativo não esteja autorizado a divulgar.

Mail

Método	Caminho	Escopo	Objetivo
GET	/v1/mail/accounts	mail:read	Listar contas de e-mail conectadas.
GET	/v1/mail/emails	mail:read	Listar mensagens.
GET	/v1/mail/emails/{emailId}	mail:read	Ler uma mensagem.
GET	/v1/mail/threads	mail:read	Listar threads.
GET	/v1/mail/threads/{threadId}	mail:read	Ler um tópico.
POST	/v1/mail/send	mail:send	Enviar uma mensagem.
GET	/v1/mail/domains	mail:read	Listar domínios de e-mail visíveis.

Work

A interface GatewayWork reflete a versão compatível de abaixoWorkAPI de /v1/work. O Gateway determina o escopo necessário a partir do método HTTP:

• Os métodos de leitura exigem work:read.
• Os métodos de criação e atualização exigem work:write.
• Os métodos de exclusão e as ações destrutivas em massa ou de cancelamento de importação exigem work:delete.

As rotas comuns incluem:

Método	Caminho	Objetivo
GET, POST	/v1/work/boards	Listar ou criar quadros.
GET, PUT, DELETE	/v1/work/boards/{boardId}	Ler, atualizar ou arquivar um quadro.
GET	/v1/work/boards/{boardId}/kanban	Ler a visualização Kanban do quadro.
GET	/v1/work/boards/{boardId}/export/csv	Exportar um quadro como CSV.
GET	/v1/work/boards/{boardId}/export/json	Exportar um instantâneo estruturado do quadro.
GET, POST	/v1/work/tickets	Pesquisar ou criar tickets.
GET, PUT, DELETE	/v1/work/tickets/{ticketId}	Ler, atualizar ou arquivar um ticket.
GET	/v1/work/me/dashboard	Retornar o resumo do painelWork ativo.
GET	/v1/work/me/quota	Retornar o usoWork e os limites atuais do .
GET, POST	/v1/work/import/jobs	Listar ou gerenciar tarefas de importação compatíveis.

Quadros, tickets, sprints, automações, importações, registros de tempo, comentários, anexos, visualizações salvas e associação ao espaço de trabalho continuam a aplicar suasWork funções e permissões de recursos após a verificação de escopo do Gateway.

Org Chart

A superfícieOrg Chart está disponível em /v1/charts. Os métodos de leitura exigem charts:read, os métodos de criação e atualização exigem charts:write, e os métodos de exclusão exigem charts:delete.

As rotas comuns incluem:

Método	Caminho	Objetivo
GET	/v1/charts/me/org-chart	Leia o gráfico do usuário ativo.
GET	/v1/charts/me/position	Leia a posição ativa do gráfico.
GET	/v1/charts/me/connections	Leia as conexões de relacionamento.
GET	/v1/charts/me/suggestions	Leia as sugestões de relacionamento.
GET	/v1/charts/users/search	Pesquise usuários para relações de gráficos.
GET	/v1/charts/orgs/{orgId}/chart	Leia um gráfico organizacional.
PATCH	/v1/charts/orgs/{orgId}/config	Atualize a configuração do gráfico.
POST	/v1/charts/orgs/{orgId}/chart/nodes	Crie um nó de gráfico.
PATCH, DELETE	/v1/charts/orgs/{orgId}/chart/nodes/{nodeId}	Atualize ou exclua um nó.

Superfícies de serviço estendidas

O Gateway também expõe os seguintes prefixos de serviço versionados:

Prefixo	Escopo de leitura	Escopo de gravação ou ação	Escopo de exclusão
/v1/forms	forms:read	forms:write	—
/v1/invoice	invoice:read	invoice:write; as ações de envio ou emissão utilizam invoice:send	invoice:delete
/v1/qa	qa:read	qa:write	—
/v1/business	business:read	business:manage	—
/v1/billing	billing:read	billing:manage	—

Esses prefixos preservam o sufixo do recurso suportado no Gateway, ao mesmo tempo em que centralizam a autenticação, o acesso ao serviço, os escopos, os limites de taxa e o contexto de auditoria. Dê preferência ao serviço oficial SDKou a uma rota explicitamente disponibilizada pelo serviço, em vez de adivinhar caminhos de recursos a partir do tráfego do navegador.

O faturamento é uma superfície do plano de controle. Ele permanece sujeito a API Gatewayacesso, limites de taxa e escopos de faturamento, mesmo quando um gateway de serviço de destino impediria um usuário de efetuar o pagamento ou realizar um upgrade.

Webhooks

O gerenciamento de webhooks utiliza /v1/webhooks e webhooks:manage. Consulte o guia dedicado guia de webhooks para registro de endpoints, verificação de entrega assinada, proteção contra repetição e rotação de segredos.

Mantenha as integrações atualizadas

• Utilize GET /v1/version para obter informações sobre a versão do Gateway.
• Ignore campos de resposta adicionais que seu cliente não reconheça.
• Leia os cabeçalhos de limite em tempo real em vez de codificar valores de plano de forma estática.
• Utilize o conjunto de escopos com o mínimo de privilégios.
• Siga o site de documentação e as notas de lançamentoSDK ao adotar uma nova rota.