Skip to main content
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, 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

Internal notes in the thread

GET /tickets/:ticketNumber/messages never returns internal notes by default. Add include_notes=true to read them in the same chronological thread:
  • The tickets:read scope covers notes; no extra scope is needed. Notes are only returned when you pass include_notes=true.
  • Every entry has a type: message for the conversation with the customer, note for an internal note. A note carries its author (author_name, author_kind, agent_id), created_at and plain text.
  • Notes share the thread’s limit, order and cursor. Note attachments, note comments and AI note suggestions are not returned.

Who wrote a message

Every entry of GET /tickets/:ticketNumber/messages has role (customer, agent or ai), author_kind and agent_id. role keeps its old values on purpose and has no value of its own for workflow, auto-reply, CSAT survey or imported messages. Use author_kind for those: customer, human, ai_agent, workflow, auto_reply, csat_survey, imported or system, with the same meaning as in messages.csv. agent_id is the opaque ID of the team member or AI agent who wrote the message, and null for every author_kind other than human and ai_agent.

Contacts

View in OpenAPI reference See Search contacts and tickets for matching rules and examples.

Attachments

View in OpenAPI reference

Tags

View in OpenAPI reference

Views

View in OpenAPI reference

Macros

View in OpenAPI reference

Teams

View in OpenAPI reference

Agents

View in OpenAPI reference

Reports

View in OpenAPI reference See Reports and metrics for the query language and example requests.

Analytics exports

View in OpenAPI reference See CSAT, session and ticket-action exports for required dashboard permissions and pagination details.

Ticket exports

View in OpenAPI reference See Ticket exports for the selection modes, file format, and limits.

Health

View in OpenAPI reference