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

# Endpoints

> Every Public API v1 endpoint, grouped by resource, with full schemas in the OpenAPI reference.

This page is a map of every `/public/v1` endpoint. It does not repeat parameters, request bodies, or response schemas — those live once, in the [OpenAPI reference](https://api.armin.cx/docs/v1), 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`

## Tickets

[View in OpenAPI reference](https://api.armin.cx/docs/v1#tag/tickets)

| Method & path | Does | Scope |
| - | - | - |
| `GET /tickets` | List tickets, optionally filtered by a [saved view](/api/filtering-and-saved-views) | `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`](/api/create-ticket) | Create a ticket | `tickets:write` |
| `POST /tickets/:ticketNumber` | Update a ticket's status, priority, or assignee | `tickets:write` |
| [`POST /tickets/:ticketNumber/messages`](/api/send-message) | Send a reply or internal note | `tickets:write` |

## Attachments

[View in OpenAPI reference](https://api.armin.cx/docs/v1#tag/attachments)

| 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` |

## Tags

[View in OpenAPI reference](https://api.armin.cx/docs/v1#tag/tags)

| Method & path | Does | Scope |
| - | - | - |
| `GET /tags` | List the organization's tags | `tags:read` |
| `POST /tags` | Create a tag | `tags:write` |

## Views

[View in OpenAPI reference](https://api.armin.cx/docs/v1#tag/views)

| Method & path | Does | Scope |
| - | - | - |
| `GET /views` | List [saved inbox views](/api/filtering-and-saved-views) | `tickets:read` |

## Teams

[View in OpenAPI reference](https://api.armin.cx/docs/v1#tag/teams)

| Method & path | Does | Scope |
| - | - | - |
| `GET /teams` | List teams tickets and agents can be assigned to | `teams:read` |

## Agents

[View in OpenAPI reference](https://api.armin.cx/docs/v1#tag/agents)

| Method & path | Does | Scope |
| - | - | - |
| `GET /agents` | List agents in the organization | `agents:read` |

## Reports

[View in OpenAPI reference](https://api.armin.cx/docs/v1#tag/reports)

See [Reports and metrics](/api/reports) for the query language and example requests.

| 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` |

## Analytics exports

[View in OpenAPI reference](https://api.armin.cx/docs/v1#tag/analytics-exports)

See [CSAT and session exports](/api/analytics-exports) for required dashboard permissions and pagination details.

| Method & path | Does | Scope |
| - | - | - |
| `GET /csat-surveys` | Export individual CSAT surveys | `analytics:read` |
| `GET /agent-sessions` | Export recorded agent login intervals | `analytics:read` |

## Health

[View in OpenAPI reference](https://api.armin.cx/docs/v1#tag/health)

| Method & path | Does | Scope |
| - | - | - |
| `GET /health` | Check API availability | None — no `cx-api-key` required |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.