Getting started - Chatarmin CX Docs

Get from zero to a working API call in a few minutes.

Prerequisites

A Chatarmin CX workspace with permission to manage API keys (Settings → API)
curl or any HTTP client (for example Postman)

Open API settings

In the dashboard, go to Settings → API.

Create a key

Click Create API key, give it a name, and select scopes. For read-only integrations and AI agents, tickets:read is enough.

Copy the key

Copy the key and store it in a secrets manager, not in source control.

See Authentication & API keys for scope details and rotation guidance.

Send a health check with your key:

curl -sS \
  -H "cx-api-key: YOUR_API_KEY" \
  "https://api.armin.cx/public/v1/health"

Expected response:

{
  "success": true,
  "data": {
    "version": "v1"
  }
}

The health endpoint requires a valid key but does not enforce a specific scope — useful to confirm auth before calling ticket routes.

curl -sS \
  -H "cx-api-key: YOUR_API_KEY" \
  "https://api.armin.cx/public/v1/tickets?limit=5"

Every v1 success response uses the { "success": true, "data": ... } envelope. List endpoints also return pagination:

{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "has_more": true,
    "next_cursor": "2026-07-20T10:00:00.000Z|019b..."
  }
}

Pass pagination.next_cursor as the cursor query parameter to fetch the next page. See Pagination.

Most agent workflows start with saved inbox views:

curl -sS \
  -H "cx-api-key: YOUR_API_KEY" \
  "https://api.armin.cx/public/v1/views"

Pick a view id, then list tickets filtered by that view:

curl -sS \
  -H "cx-api-key: YOUR_API_KEY" \
  "https://api.armin.cx/public/v1/tickets?view_id=VIEW_UUID&limit=40"

See Filtering & saved views for the full workflow.

Full endpoint reference with schemas and Try it.

Common AI agent patterns mapped to API calls.