Referenz der Service-Endpunkte

Alle Pfade auf dieser Seite beziehen sich auf:

https://api.champrep.com

Verwenden Sie eine bereichsbezogene Bearer-Anmeldeinformation, wie im Abschnitt „Authentifizierung und API-Schlüssel“ beschrieben. Authentifizierung und SchlüsselAPI. Eine aufgeführte Route unterliegt weiterhin der aktuellen Serviceverfügbarkeit, den Einstellungen für Tarife und Organisationen, den Rollenberechtigungen, dem Ressourcenzugriff sowie den Live-Nutzungskontrollen.

Dienstübersicht

Bereich	Präfix	Gültigkeitsbereiche
Identität und Profil	/v1/auth, /v1/users	users:read sowie den Kontext der Anmeldedaten
Suche dienstübergreifend	/v1/search	Der Lesebereich jedes durchsuchten Dienstes
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
Abrechnung	/v1/billing	billing:read, billing:manage
Webhooks	/v1/webhooks	webhooks:manage

GET, HEAD, und OPTIONS erfordern in der Regel den Lesebereich. Methoden zum Erstellen, Aktualisieren und Ausführen von Aktionen erfordern den Schreib- oder Verwaltungsbereich. Löschmethoden erfordern einen Löschbereich, sofern der Dienst einen solchen definiert. Eine Route kann zusätzliche Rollen- oder Ressourcenberechtigungen im Ziel-Dienst erfordern.

Identitäts- und Gateway-Status

Methode	Pfad	Zweck
GET	/v1/version	Geben Sie Informationen zur öffentlichen Gateway-Version zurück.
GET	/v1/auth/whoami	Den aktiven Benutzer, das Profil, die Anmeldedaten und den Tarifkontext zurückgeben.
GET	/v1/auth/quota	Den aktuellen Snapshot des Schlüssel- und Gateway-Kontingents zurückgeben.
GET	/v1/users/me	Das Profil des aktuellen Benutzers zurückgeben.
GET	/v1/users/me/notifications	Benachrichtigungen auflisten, die für den aktuellen Benutzer sichtbar sind.

Der browsergestützte AustauschCLI nutzt zudem /v1/auth/cli/start, /v1/auth/cli/device, und /v1/auth/cli/poll. Diese Routen werden von der offiziellen Anwendung implementiertCLI; benutzerdefinierte Anwendungen sollten das GenehmigungsprotokollCLI nicht nachahmen, wenn ein SchlüsselAPI ihren Anforderungen entspricht.

Suche dienstübergreifend

Methode	Pfad	Gültigkeitsbereich	Zweck
GET	/v1/search	Pro Dienst, siehe unten	Durchsuchen Sie alle Dienste, auf die diese Anmeldedaten Zugriff haben, in einem einzigen Aufruf.
GET	/v1/search/services	Keine	Geben Sie an, welche Dienste mit diesen Anmeldedaten durchsucht werden können.

/v1/search verteilt die Anfrage auf die Dienste, die die Suche unterstützen, und führt die Ergebnisse zusammen. Parameter:

Parameter	Standard	Zweck
q	erforderlich	Der Suchbegriff.
limit	5	Maximale Ergebnisse pro Dienst, bis zu 20.
services	alle	Durch Kommas getrennte Liste, zum Beispiel mail,drive. Dies schränkt den Fan-Out ein.
semantic	false	Einstellungen true um die Ergebnisse mit KI neu zu ordnen und eine kurze Antwort zu erhalten. Verbraucht Ihre eigenen KI-Guthaben.

Intelligente Suche mit KI

semantic=true fügt einen KI-Durchlauf über die bereits vorliegenden Ergebnisse hinzu: Er liest Ihre Frage, ordnet die Treffer danach neu, wie gut sie diese beantworten, fügt jedem eine kurze Begründung hinzu und liefert einen ein Absatz langen answer.

Die Kosten werden mit Ihren eigenen KI-Guthaben beglichen. – das entspricht dem gleichen monatlichen Kontingent, das der CHAMPREP AIAssistent nutzt. Es fallen keine Kosten an, solange Sie nicht danach fragen, und die Stichwortsuche kostet niemals KI-Guthaben.

Jede Antwort gibt Auskunft darüber, was in semantic:

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

Wenn der KI-Durchlauf nicht ausgeführt werden kann, werden Ihre Suchergebnisse unverändert zurückgegeben und semantic Erklärt, warum:

reason	Bedeutung
AI_CREDITS_EXHAUSTED	Sie haben Ihre monatlichen KI-Guthaben aufgebraucht.
PLAN_NO_AI	Ihr Tarif umfasst den KI-Dienst nicht.
AI_UNAVAILABLE	Der KI-Dienst war dieses Mal nicht erreichbar.

Ein fehlgeschlagener KI-Durchlauf führt niemals zu einem Fehlschlag der Suche. Rufen Sie an /v1/search/services zu prüfen, ob die Smart-Suche verfügbar ist – sie gibt semantic.available sowie Ihre verbleibenden Guthaben – und blenden Sie die KI-Option aus, wenn dies nicht der Fall ist.

Ein Dienst ist nur dann enthalten, wenn die Anmeldeinformationen über den entsprechenden Lesebereich verfügen (mail:read, drive:read, notes:read, calendar:read, chat:read, work:read, invoice:read, contacts:read) und sofern der aktive Tarif dies zulässt. Beide Prüfungen schlagen fehl, sodass ein Dienst, den Sie nicht nutzen können, niemals Ergebnisse liefert.

Chat Nachrichten werden im Ruhezustand verschlüsselt und nur innerhalb der Räume durchsucht, denen Sie angehören, wobei der aktuelle Verlauf anstelle des gesamten Archivs herangezogen wird.

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

Die Ergebnisse werden nach Diensten gruppiert und auf ein einheitliches Format normiert, sodass ein Client jeden Dienst auf dieselbe Weise darstellt:

{
  "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
  }
}

Lesen skipped bevor Sie ein leeres Ergebnis als „Nichts gefunden“ behandeln. Jeder Eintrag erklärt, warum ein Dienst ausgelassen wurde – INSUFFICIENT_SCOPE, NOT_IN_PLAN, oder SERVICE_UNAVAILABLE wenn ein Backend zu langsam oder kurzzeitig nicht erreichbar war. Ein nicht verfügbarer Dienst führt niemals zum Scheitern der gesamten Abfrage; die übrigen Ergebnisse werden weiterhin zurückgegeben.

Was eine Suche kostet

Eine Suche greift auf einen Dienst pro Ergebnisgruppe zu, daher wird sie auch entsprechend abgerechnet: eine Ratenbegrenzungseinheit pro tatsächlich durchsuchtem Dienst. Die cost Das Feld in jeder Antwort gibt genau an, was in Rechnung gestellt wurde, und X-RateLimit-Remaining Dies wird bereits berücksichtigt, bevor Sie die Antwort erhalten.

Anfrage	Durchsuchte Dienste	Kosten
?q=roadmap bei einem Tarif mit allen acht	8	8
?q=roadmap&services=mail	1	1
?q=roadmap bei einem Tarif mit nur Notes	1	1

Ihnen werden niemals Kosten für einen Dienst berechnet, den Sie nicht nutzen können; daher ist die Eingrenzung mit services ist der kostengünstigste Weg, um eine interaktive Suche reaktionsschnell zu halten. Wenden Sie stets ein Debounce an – senden Sie niemals eine Anfrage pro Tastenanschlag.

Drive

Methode	Pfad	Gültigkeitsbereich	Zweck
GET	/v1/drive/files	drive:read	Dateien auflisten oder suchen. Verwenden Sie die search Abfrage bei Bedarf.
GET	/v1/drive/folders	drive:read	Inhalt des Stammordners auflisten.
GET	/v1/drive/folders/{folderId}	drive:read	Den Inhalt eines Ordners auflisten.
GET	/v1/drive/starred	drive:read	Mit Stern markierte Elemente auflisten.
GET	/v1/drive/recent	drive:read	Letzte Elemente auflisten.
GET	/v1/drive/shared	drive:read	Geteilte Elemente auflisten.
GET	/v1/drive/quota	drive:read	Aktuelle Speicherauslastung und -verfügbarkeit zurückgeben.
POST	/v1/drive/upload	drive:write	Erstellen Sie ein Upload-Ziel.
POST	/v1/drive/files	drive:write	Speichern Sie die Metadaten der Datei nach erfolgreichem Upload.
POST	/v1/drive/download	drive:read	Ein Download-Ziel erstellen.
POST	/v1/drive/folders	drive:write	Erstellen Sie einen Ordner.
POST	/v1/drive/rename	drive:write	Ein Element verschieben oder umbenennen.
POST	/v1/drive/delete	drive:delete	Ein oder mehrere Elemente löschen.
DELETE	/v1/drive/files/{fileId}	drive:delete	Löschen Sie eine Datei über den bisherigen Einzelobjekt-Weg.

Der Upload ist ein mehrstufiger Vorgang: Anfordern eines Upload-Ziels, Übertragen der Bytes an dieses Ziel und Speichern der resultierenden Metadaten. Verwenden Sie die offizielle oderSDK ,CLI wenn Sie diese Abfolge nicht selbst implementieren müssen.

Chat

Methode	Pfad	Gültigkeitsbereich	Zweck
GET	/v1/chat/rooms	chat:read	Räume auflisten, die für das aktive Profil sichtbar sind.
GET	/v1/chat/rooms/{roomId}	chat:read	Einen Raum einsehen.
POST	/v1/chat/rooms	chat:write	Einen Raum erstellen.
GET	/v1/chat/rooms/{roomId}/messages	chat:read	Raumnachrichten auflisten.
POST	/v1/chat/rooms/{roomId}/messages	chat:write	Eine Raumnachricht senden.
GET	/v1/chat/messages/search	chat:read	Nachrichten suchen.
GET	/v1/chat/unread	chat:read	Anzahl ungelesener Nachrichten zurückgeben.
GET	/v1/chat/favorites	chat:read	Favorisierte Nachrichten auflisten.

Calendar

Methode	Pfad	Gültigkeitsbereich	Zweck
GET	/v1/calendar/events	calendar:read	Termine auflisten; unterstützt startDate und endDate Abfragen.
GET	/v1/calendar/events/{eventId}	calendar:read	Ein Ereignis abrufen.
POST	/v1/calendar/events	calendar:write	Erstellen Sie eine Veranstaltung.
PATCH	/v1/calendar/events/{eventId}	calendar:write	Ereignis aktualisieren.
DELETE	/v1/calendar/events/{eventId}	calendar:write	Ein Ereignis löschen.
GET	/v1/calendar/upcoming	calendar:read	Anstehende Besprechungen auflisten.
GET	/v1/calendar/invitations	calendar:read	Ausstehende Einladungen auflisten.

Senden Sie Zeitstempel von Terminen im ISO 8601-Format mit einer expliziten Zeitzone. Das Erstellen und Aktualisieren von Terminen beansprucht das für den aktiven Tarif und die Organisation konfigurierte Kontingent; die APIlegt kein universelles, festes Tariflimit fest.

Contacts

Methode	Pfad	Gültigkeitsbereich	Zweck
GET	/v1/contacts	contacts:read	Kontakte auflisten.
GET	/v1/contacts/search	contacts:read	Kontakte mit suchen q oder email.
GET	/v1/contacts/favorites	contacts:read	Favoriten auflisten.
GET	/v1/contacts/labels	contacts:read	Zeigen Sie Labels an.
GET	/v1/contacts/{contactId}	contacts:read	Einen Kontakt abrufen.
POST	/v1/contacts	contacts:write	Einen Kontakt hinzufügen.
PUT	/v1/contacts/{contactId}	contacts:write	Aktualisieren Sie die Metadaten eines Kontakts.
DELETE	/v1/contacts/{contactId}	contacts:write	Einen Kontakt löschen.

Meet

Methode	Pfad	Gültigkeitsbereich	Zweck
GET	/v1/meet/rooms	meet:read	Besprechungsräume auflisten.
GET	/v1/meet/rooms/{roomId}	meet:read	Einen Raum einsehen.
POST	/v1/meet/rooms	meet:write	Einen Raum erstellen.
GET	/v1/meet/sessions	meet:read	Besprechungssitzungen auflisten.
GET	/v1/meet/sessions/{sessionId}/participants	meet:read	Listen Sie die Sitzungsteilnehmer auf.
GET	/v1/meet/recordings	meet:read	Verfügbare Aufzeichnungen auflisten.
GET	/v1/meet/transcriptions	meet:read	Transkriptionen auflisten.
GET	/v1/meet/transcriptions/{sessionId}	meet:read	Lesen Sie eine Transkription der abschließenden Sitzung.
GET	/v1/meet/usage	meet:read	Die aktuelle Nutzung von Besprechungen zurückgeben.

Der Zugriff auf Aufzeichnungen und Transkriptionen hängt von der Eigentümerschaft der Besprechung, der Einwilligung, der Aufbewahrungsfrist, dem Tarif und den Richtlinien der Organisation ab.

Notes

Methode	Pfad	Gültigkeitsbereich	Zweck
GET	/v1/notes	notes:read	Notizen auflisten.
GET	/v1/notes/shared	notes:read	Notizen auflisten, die für das aktive Profil freigegeben sind.
GET	/v1/notes/{noteId}	notes:read	Eine Notiz lesen.
POST	/v1/notes	notes:write	Eine Notiz erstellen.
PATCH	/v1/notes/{noteId}	notes:write	Eine Notiz aktualisieren.
DELETE	/v1/notes/{noteId}	notes:write	Eine Notiz löschen.
POST	/v1/notes/{noteId}/share	notes:write	Eine Notiz unter Verwendung der unterstützten Zugriffseinstellungen freigeben.

Learn und Kurse

/v1/learn und /v1/courses die gleichen kuratierten Kurspfade bereitstellen.

Methode	Pfad	Gültigkeitsbereich	Zweck
GET	/v1/learn	courses:read	Verfügbare Kurse auflisten.
GET	/v1/learn/enrolled/my	courses:read	Die Anmeldungen des aktiven Benutzers auflisten.
GET	/v1/learn/{courseId}	courses:read	Einen Kurs abrufen.
GET	/v1/learn/{courseId}/sections	courses:read	Kursabschnitte auflisten.
POST	/v1/learn	courses:write	Einen Kurs erstellen, sofern die Rolle dies zulässt.
PUT	/v1/learn/{courseId}	courses:write	Einen Kurs aktualisieren, sofern die Rolle dies zulässt.

Verwenden Sie das /v1/courses Verwenden Sie stattdessen das Präfix, wenn Sie eine Integration pflegen, die diesen Alias bereits verwendet.

CHAMPREP AI

Methode	Pfad	Gültigkeitsbereich	Zweck
POST	/v1/ai/chat	ai:chat	Senden Sie eine Eingabeaufforderung oder eine unterstützte Konversationsnachricht.
GET	/v1/ai/conversations	ai:chat	Gespeicherte Unterhaltungen auflisten.
GET	/v1/ai/conversations/{conversationId}	ai:chat	Eine Konversation abrufen.
DELETE	/v1/ai/conversations/{conversationId}	ai:chat	Eine Konversation löschen.
GET	/v1/ai/usage	ai:chat	Die aktuelle KI-Nutzung abrufen.

AI-Ausgaben können unvollständig oder fehlerhaft sein. Überprüfen Sie wichtige Ausgaben und senden Sie keine Daten, zu deren Weitergabe der aktive Benutzer nicht berechtigt ist.

Mail

Methode	Pfad	Gültigkeitsbereich	Zweck
GET	/v1/mail/accounts	mail:read	Listen Sie verbundene E-Mail-Konten auf.
GET	/v1/mail/emails	mail:read	Nachrichten auflisten.
GET	/v1/mail/emails/{emailId}	mail:read	Eine Nachricht lesen.
GET	/v1/mail/threads	mail:read	Listen Sie Threads auf.
GET	/v1/mail/threads/{threadId}	mail:read	Einen Thread abrufen.
POST	/v1/mail/send	mail:send	Eine Nachricht senden.
GET	/v1/mail/domains	mail:read	Sichtbare E-Mail-Domänen auflisten.

Work

Die Work„Gateway“-Oberfläche spiegelt die unterstützte, versionierte unterWorkAPI /v1/work. Das Gateway ermittelt den erforderlichen Umfang anhand der HTTP-Methode:

• Lese-Methoden erfordern work:read.
• Die Methoden „create“ und „update“ erfordern work:write.
• Löschmethoden sowie destruktive Massenaktionen oder Aktionen zum Abbrechen von Importen erfordern work:delete.

Zu den gängigen Routen gehören:

Methode	Pfad	Zweck
GET, POST	/v1/work/boards	Boards auflisten oder erstellen.
GET, PUT, DELETE	/v1/work/boards/{boardId}	Ein Board lesen, aktualisieren oder archivieren.
GET	/v1/work/boards/{boardId}/kanban	Lesen Sie die Kanban-Ansicht des Boards.
GET	/v1/work/boards/{boardId}/export/csv	Ein Board als CSV exportieren.
GET	/v1/work/boards/{boardId}/export/json	Einen strukturierten Board-Snapshot exportieren.
GET, POST	/v1/work/tickets	Tickets suchen oder erstellen.
GET, PUT, DELETE	/v1/work/tickets/{ticketId}	Ein Ticket lesen, aktualisieren oder archivieren.
GET	/v1/work/me/dashboard	Rufen Sie die Zusammenfassung des aktiven „Work“-DashboardsWork ab.
GET	/v1/work/me/quota	Geben Sie die aktuelle NutzungWork und die Limits zurück.
GET, POST	/v1/work/import/jobs	Unterstützte Importaufträge auflisten oder verwalten.

Boards, Tickets, Sprints, Automatisierungen, Importe, Zeiterfassungen, Kommentare, Anhänge, gespeicherte Ansichten und die Zugehörigkeit zu Arbeitsbereichen unterliegen auch nach der Gateway-Gültigkeitsbereichsprüfung weiterhin ihrenWork Rollen und Ressourcenberechtigungen.

Org Chart

Die OberflächeOrg Chart „“ ist unter /v1/charts. Lese-Methoden erfordern charts:read, Methoden zum Erstellen und Aktualisieren erfordern charts:writeDie Methoden „“, „“ und „delete“ erfordern charts:delete.

Zu den gängigen Routen gehören:

Methode	Pfad	Zweck
GET	/v1/charts/me/org-chart	Lesen Sie das Diagramm des aktiven Benutzers.
GET	/v1/charts/me/position	Lesen Sie die aktuelle Chart-Position ab.
GET	/v1/charts/me/connections	Lesezugriff auf Beziehungsverbindungen.
GET	/v1/charts/me/suggestions	Lesen Sie Vorschläge zu Beziehungen.
GET	/v1/charts/users/search	Suchen Sie nach Benutzern für Diagrammbeziehungen.
GET	/v1/charts/orgs/{orgId}/chart	Lesen Sie ein Organisationsdiagramm.
PATCH	/v1/charts/orgs/{orgId}/config	Aktualisieren Sie die Diagrammkonfiguration.
POST	/v1/charts/orgs/{orgId}/chart/nodes	Erstellen Sie einen Diagrammknoten.
PATCH, DELETE	/v1/charts/orgs/{orgId}/chart/nodes/{nodeId}	Knoten aktualisieren oder löschen.

Erweiterte Serviceoberflächen

Das Gateway stellt außerdem die folgenden versionierten Dienstpräfixe bereit:

Präfix	Lesebereich	Schreib- oder Aktionsbereich	Löschbereich
/v1/forms	forms:read	forms:write	—
/v1/invoice	invoice:read	invoice:write; zum Senden oder Auslösen von Aktionen verwenden invoice:send	invoice:delete
/v1/qa	qa:read	qa:write	—
/v1/business	business:read	business:manage	—
/v1/billing	billing:read	billing:manage	—

Diese Präfixe bewahren das unterstützte Ressourcen-Suffix unterhalb des Gateways bei und zentralisieren gleichzeitig Authentifizierung, Dienstzugriff, Bereiche, Ratenbegrenzungen und den Audit-Kontext. Bevorzugen Sie den offiziellen Dienst oderSDK eine vom Dienst explizit bereitgestellte Route, anstatt Ressourcenpfade aus dem Browser-Datenverkehr zu erraten.

Die Abrechnung ist eine Schnittstelle der Steuerungsebene. Sie unterliegt weiterhin den API GatewayZugriffs-, Ratenbegrenzungs- und Abrechnungsbereichen, selbst wenn ein Ziel-Service-Gate einen Benutzer daran hindern würde, eine Zahlung zu korrigieren oder ein Upgrade durchzuführen.

Webhooks

Die Webhook-Verwaltung verwendet /v1/webhooks und webhooks:manage. Weitere Informationen finden Sie im entsprechenden Webhook-Handbuch für die Endpunktregistrierung, die Überprüfung signierter Übermittlungen, den Wiederholungsschutz und die Rotation von Geheimnissen.

Halten Sie Ihre Integrationen auf dem neuesten Stand

• Verwenden Sie GET /v1/version für Informationen zur Gateway-Version.
• Ignorieren Sie zusätzliche Antwortfelder, die Ihr Client nicht versteht.
• Lesen Sie die Live-Limit-Header aus, anstatt Planwerte fest zu programmieren.
• Verwenden Sie den Umfang mit den geringsten Berechtigungen.
• Beachten Sie die Dokumentationsseite und die SDKVersionshinweise, wenn Sie eine neue Route einführen.