Skip to main content
Die Chatarmin CX Public API v1 ermöglicht dir, Tickets, gespeicherte Posteingang-Ansichten und Konversationsverläufe programmatisch zu lesen — und Tickets über POST /public/v1/tickets anzulegen. Nutze sie für Dashboards, Data-Warehouse-Syncs, Tickets aus externen Systemen oder KI-Agenten mit Live-Support-Kontext.

Was v1 enthält

Tickets, Nachrichten, Attachments, Tags, gespeicherte Ansichten, Teams, Agenten, Reports und Analytics-Exporte. Die vollständige Liste nach Ressource gruppiert steht unter Endpoints, Schemas und ein Live-Request-Builder in der OpenAPI-Referenz. Basis-URL: https://api.armin.cx/public/v1

Was v1 nicht enthält

Kundenantworten und CSV/Excel-Export bleiben auf Legacy /public/*. Für Analytics nutzt du Berichte und Metriken mit einem Agenten-zugewiesenen API-Schlüssel und analytics:read. Tickets anlegen: Ticket erstellen (tickets:write, 30 req/min). Du kannst Tickets nicht mit Ad-hoc-Query-Parametern filtern (Status, Kanal, Datumsbereich, Volltextsuche). Lege Filter in einer gespeicherten Posteingang-Ansicht an und übergib view_id.

Dokumentationsübersicht

Erste Schritte

API-Schlüssel erstellen und ersten Request senden.

Endpoints

Alle Endpoints nach Ressource gruppiert, mit Links zur OpenAPI-Referenz.

OpenAPI-Referenz

Alle Endpoints, Schemas und Try it — inkl. Ticket erstellen.

Ticket erstellen

Anleitung zum Anlegen von Tickets aus eigenen Systemen.

Agent-Tool-Beispiele

Typische Agenten-Aufgaben auf API-Aufrufe mappen.

Authentifizierung

API-Schlüssel, Scopes und Least-Privilege-Setup.

Lesekonsistenz

Public v1 liest von der Read-Replica. Antworten können unter hoher Schreiblast einige Sekunden hinter der Posteingang-Oberfläche liegen. Für Agenten-Tools nach Kundennachrichten: kurzes Backoff statt enger Polling-Schleifen.