> ## Documentation Index
> Fetch the complete documentation index at: https://docs.armin.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Read-only ticket and message API for integrations and AI agent tools.

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](/inbox/views-and-filters) and pass `view_id` instead.

## Documentation map

<CardGroup cols={2}>
  <Card title="Getting started" icon="rocket" href="/api/getting-started">
    Create an API key and make your first request.
  </Card>

  <Card title="Agent tool examples" icon="robot" href="/api/agent-tool-examples">
    Map common agent tasks to API calls.
  </Card>

  <Card title="Authentication" icon="key" href="/api/authentication">
    API keys, scopes, and least-privilege setup.
  </Card>

  <Card title="OpenAPI reference" icon="book" href="https://api.armin.cx/docs/v1">
    Interactive Scalar docs with request/response schemas.
  </Card>
</CardGroup>

## 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.