Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Alle Public API v1 Endpoints, gruppiert nach Ressource, mit vollständigen Schemas in der OpenAPI-Referenz.
/public/v1-Endpoints. Sie wiederholt keine Parameter, Request-Bodies oder Response-Schemas — die stehen einmal, in der OpenAPI-Referenz, wo du jeden Request auch direkt ausprobieren kannst. Nutze die Links unten, um direkt zu einer Ressource zu springen.
Basis-URL: https://api.armin.cx/public/v1
| Methode & Pfad | Macht | Scope |
|---|---|---|
GET /tickets | Tickets auflisten, optional gefiltert über eine gespeicherte Ansicht | tickets:read |
GET /tickets/:ticketNumber | Einzelnes Ticket per Nummer abrufen | tickets:read |
GET /tickets/:ticketNumber/messages | Konversationsverlauf eines Tickets lesen | tickets:read |
POST /tickets | Ticket erstellen | tickets:write |
POST /tickets/:ticketNumber | Status, Priorität oder Zuweisung eines Tickets ändern | tickets:write |
POST /tickets/:ticketNumber/messages | Antwort oder interne Notiz senden | tickets:write |
| Methode & Pfad | Macht | Scope |
|---|---|---|
POST /attachments/upload-url | Signierte URL für einen Datei-Upload anfordern | tickets:write |
POST /attachments/:attachmentId/confirm | Upload bestätigen, damit er an ein Ticket angehängt werden kann | tickets:write |
| Methode & Pfad | Macht | Scope |
|---|---|---|
GET /tags | Tags der Organisation auflisten | tags:read |
POST /tags | Tag erstellen | tags:write |
| Methode & Pfad | Macht | Scope |
|---|---|---|
GET /views | Gespeicherte Posteingang-Ansichten auflisten | tickets:read |
| Methode & Pfad | Macht | Scope |
|---|---|---|
GET /teams | Teams auflisten, denen Tickets und Agenten zugewiesen werden können | teams:read |
| Methode & Pfad | Macht | Scope |
|---|---|---|
GET /agents | Agenten der Organisation auflisten | agents:read |
| Methode & Pfad | Macht | Scope |
|---|---|---|
GET /reports/metrics | Metrik-IDs für POST /reports/query entdecken | analytics:read |
POST /reports/query | Berichtsdaten mit der CX-Abfragesprache abfragen | analytics:read |
| Methode & Pfad | Macht | Scope |
|---|---|---|
GET /csat-surveys | Einzelne CSAT-Umfragen exportieren | analytics:read |
GET /agent-sessions | Erfasste Agenten-Login-Intervalle exportieren | analytics:read |
| Methode & Pfad | Macht | Scope |
|---|---|---|
GET /health | API-Verfügbarkeit prüfen | Keiner — kein cx-api-key nötig |