/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 referenceInternal 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:readscope covers notes; no extra scope is needed. Notes are only returned when you passinclude_notes=true. - Every entry has a
type:messagefor the conversation with the customer,notefor an internal note. A note carries its author (author_name,author_kind,agent_id),created_atand plaintext. - Notes share the thread’s
limit,orderandcursor. Note attachments, note comments and AI note suggestions are not returned.
Who wrote a message
Every entry ofGET /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.