Übersicht - Chatarmin CX Docs

Die Chatarmin CX Public API v1 ermöglicht dir, Tickets, gespeicherte Posteingang-Ansichten und Konversationsverläufe programmatisch aus deinem Workspace zu lesen. Nutze sie für eigene Dashboards, Data-Warehouse-Syncs oder KI-Agenten mit Live-Support-Kontext.

Was v1 enthält

Funktion	Endpoint
Tickets auflisten (Cursor-Pagination, optionale Ansicht)	`GET /public/v1/tickets`
Einzelnes Ticket per Nummer abrufen	`GET /public/v1/tickets/:ticketNumber`
Konversationsnachrichten lesen	`GET /public/v1/tickets/:ticketNumber/messages`
Gespeicherte Posteingang-Ansichten auflisten	`GET /public/v1/views`
Health Check	`GET /public/v1/health`

Basis-URL: https://api.armin.cx/public/v1

Was v1 nicht enthält

v1 ist nur lesend. Tickets erstellen, Kunden antworten, CSV/Excel-Export und Analytics bleiben auf der Legacy-Oberfläche /public/*, bis eine spätere Version kommt. 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.

Agent-Tool-Beispiele

Typische Agenten-Aufgaben auf API-Aufrufe mappen.

Authentifizierung

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

OpenAPI-Referenz

Interaktive Scalar-Docs mit Request-/Response-Schemas.

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.

​Was v1 enthält

​Was v1 nicht enthält

​Dokumentationsübersicht