Skip to main content
The Chatarmin CX Public API v1 lets you read tickets, saved inbox views, and conversation threads from your workspace programmatically — and create tickets via POST /public/v1/tickets. Use it to build custom dashboards, sync data to your data warehouse, open tickets from external systems, or power AI agents that need live support context.

​
What v1 includes

Base URL: https://api.armin.cx/public/v1

​
What v1 does not include

v1 does not include replying to customers or exporting CSV/Excel. Those remain on the legacy /public/* surface. For analytics, use Reports and metrics with an agent-assigned API key and analytics:read. To create tickets, use Create a ticket (tickets:write, 30 req/min). You cannot filter tickets with ad-hoc query parameters (status, channel, date range, full-text search). Encode those filters in a saved inbox view and pass view_id instead.

​
Documentation map

Getting started

Create an API key and make your first request.

OpenAPI reference

All endpoints, schemas, and Try it — including create ticket.

Create a ticket

Setup guide for opening tickets from your own systems.

Agent tool examples

Map common agent tasks to API calls.

Authentication

API keys, scopes, and least-privilege setup.

​
Read consistency

Public v1 reads from the database read replica. Responses may lag the inbox UI by a few seconds under heavy write load. For agent tools that poll after a customer message, prefer short backoff rather than tight loops.