Overview - Chatarmin CX Docs

The Chatarmin CX Public API v1 lets you read tickets, saved inbox views, and conversation threads from your workspace programmatically. Use it to build custom dashboards, sync data to your data warehouse, or power AI agents that need live support context.

What v1 includes

Capability	Endpoint
List tickets (cursor pagination, optional saved view)	`GET /public/v1/tickets`
Get a single ticket by number	`GET /public/v1/tickets/:ticketNumber`
Read conversation messages	`GET /public/v1/tickets/:ticketNumber/messages`
List saved inbox views	`GET /public/v1/views`
Health check	`GET /public/v1/health`

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

What v1 does not include

v1 is read-only. Creating tickets, replying to customers, exporting CSV/Excel, and analytics endpoints remain on the legacy /public/* surface until a future release. 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.

Agent tool examples

Map common agent tasks to API calls.

Authentication

API keys, scopes, and least-privilege setup.

OpenAPI reference

Interactive Scalar docs with request/response schemas.

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.

​What v1 includes

​What v1 does not include

​Documentation map