8.Endpoint summary

8.Endpoint summary

The following table lists all available ATS API endpoints. All endpoints require an ATS manager account. Endpoints marked Pro require Akeeba Ticket System Professional and the "Web Services - Akeeba Ticket System" plugin.

MethodPathActionPro?
GET/v1/ats/categoriesList ATS categoriesYes
GET/v1/ats/categories/:idShow a categoryYes
GET/v1/ats/ticketsList ticketsYes
POST/v1/ats/ticketsCreate a ticketYes
GET/v1/ats/tickets/:idShow a ticketYes
PATCH/v1/ats/tickets/:idUpdate a ticketYes
DELETE/v1/ats/tickets/:idDelete a ticketYes
GET/v1/ats/tickets/:ticket_id/postsList posts for a ticketYes
POST/v1/ats/tickets/:ticket_id/postsCreate a post on a ticketYes
GET/v1/ats/postsList all postsYes
GET/v1/ats/posts/:idShow a postYes
PATCH/v1/ats/posts/:idUpdate a postYes
DELETE/v1/ats/posts/:idDelete a postYes
GET/v1/ats/posts/:post_id/attachmentsList attachments for a postPro only
POST/v1/ats/posts/:post_id/attachmentsUpload an attachmentPro only
GET/v1/ats/attachmentsList all attachmentsPro only
GET/v1/ats/attachments/:idShow an attachmentPro only
GET/v1/ats/attachments/:id/downloadDownload attachment filePro only
DELETE/v1/ats/attachments/:idDelete an attachmentPro only
GET/v1/ats/tickets/:ticket_id/notesList notes for a ticketPro only
POST/v1/ats/tickets/:ticket_id/notesCreate a note on a ticketPro only
GET/v1/ats/notesList all manager notesPro only
GET/v1/ats/notes/:idShow a manager notePro only
PATCH/v1/ats/notes/:idUpdate a manager notePro only
DELETE/v1/ats/notes/:idDelete a manager notePro only