Zum Hauptinhalt springen
Diese Seite ist eine Übersicht aller /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

Tickets

In der OpenAPI-Referenz ansehen

Interne Notizen im Verlauf

GET /tickets/:ticketNumber/messages liefert standardmäßig keine internen Notizen. Mit include_notes=true erscheinen sie im selben chronologischen Verlauf:
  • Der Scope tickets:read deckt Notizen ab, ein zusätzlicher Scope ist nicht nötig. Notizen kommen nur mit include_notes=true.
  • Jeder Eintrag hat einen type: message für die Konversation mit dem Kunden, note für eine interne Notiz. Eine Notiz enthält ihren Autor (author_name, author_kind, agent_id), created_at und den Klartext text.
  • Notizen teilen sich limit, order und cursor mit dem Verlauf. Anhänge von Notizen, Notiz-Kommentare und KI-Notizvorschläge werden nicht zurückgegeben.

Wer eine Nachricht geschrieben hat

Jeder Eintrag von GET /tickets/:ticketNumber/messages hat role (customer, agent oder ai), author_kind und agent_id. role behält absichtlich seine bisherigen Werte und hat keinen eigenen Wert für Workflow-, Auto-Reply-, CSAT-Umfrage- oder importierte Nachrichten. Nutze dafür author_kind: customer, human, ai_agent, workflow, auto_reply, csat_survey, imported oder system, mit derselben Bedeutung wie in messages.csv. agent_id ist die undurchsichtige ID des Autors der Nachricht (Teammitglied oder KI-Agent) und null bei jedem author_kind außer human und ai_agent.

Contacts

In der OpenAPI-Referenz ansehen Suchregeln und Beispiele findest du unter Kontakte und Tickets suchen.

Attachments

In der OpenAPI-Referenz ansehen

Tags

In der OpenAPI-Referenz ansehen

Views

In der OpenAPI-Referenz ansehen

Macros

In der OpenAPI-Referenz ansehen

Teams

In der OpenAPI-Referenz ansehen

Agents

In der OpenAPI-Referenz ansehen

Reports

In der OpenAPI-Referenz ansehen Die Abfragesprache und Beispiel-Requests stehen in Berichte und Metriken.

Analytics-Exporte

In der OpenAPI-Referenz ansehen Benötigte Dashboard-Berechtigungen und Pagination stehen in CSAT-, Sitzungs- und Ticketaktionsexporte.

Ticket-Exporte

In der OpenAPI-Referenz ansehen Auswahlmodi, Dateiformat und Limits stehen in Ticket-Exporte.

Health

In der OpenAPI-Referenz ansehen