Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Every Public API v1 endpoint, grouped by resource, with full schemas in the OpenAPI reference.
/public/v1 endpoint. It does not repeat parameters, request bodies, or response schemas — those live once, in the OpenAPI reference, where you can also try each request live. Use the links below to jump straight to a resource.
Base URL: https://api.armin.cx/public/v1
| Method & path | Does | Scope |
|---|---|---|
GET /tickets | List tickets, optionally filtered by a saved view | tickets:read |
GET /tickets/:ticketNumber | Get a single ticket by number | tickets:read |
GET /tickets/:ticketNumber/messages | Read a ticket’s conversation thread | tickets:read |
POST /tickets | Create a ticket | tickets:write |
POST /tickets/:ticketNumber | Update a ticket’s status, priority, or assignee | tickets:write |
POST /tickets/:ticketNumber/tags | Add tags to a ticket, by id | tickets:write |
DELETE /tickets/:ticketNumber/tags | Remove tags from a ticket, by id | tickets:write |
POST /tickets/:ticketNumber/messages | Send a reply or internal note | tickets:write |
| Method & path | Does | Scope |
|---|---|---|
POST /attachments/upload-url | Get a signed URL to upload a file | tickets:write |
POST /attachments/:attachmentId/confirm | Confirm an upload so it can be attached to a ticket | tickets:write |
| Method & path | Does | Scope |
|---|---|---|
GET /tags | List the organization’s tags | tags:read |
POST /tags | Create a tag | tags:write |
| Method & path | Does | Scope |
|---|---|---|
GET /views | List saved inbox views | tickets:read |
| Method & path | Does | Scope |
|---|---|---|
GET /teams | List teams tickets and agents can be assigned to | teams:read |
| Method & path | Does | Scope |
|---|---|---|
GET /agents | List agents in the organization | agents:read |
| Method & path | Does | Scope |
|---|---|---|
GET /reports/metrics | Discover metric IDs for use in POST /reports/query | analytics:read |
POST /reports/query | Query report data with the CX query language | analytics:read |
| Method & path | Does | Scope |
|---|---|---|
GET /csat-surveys | Export individual CSAT surveys | analytics:read |
GET /agent-sessions | Export recorded agent login intervals | analytics:read |
| Method & path | Does | Scope |
|---|---|---|
GET /health | Check API availability | None — no cx-api-key required |