Chapter8.Joomla API integration
Chapter8.Joomla API integration
PrevPartI.User's GuideNext

Chapter8.Joomla API integration

Table of Contents

1. Requirements and setup
2. API conventions
2.1. Authentication
2.2. Base URL
2.3. Response format
2.4. Error responses
2.5. List ordering and pagination
2.6. User information objects
3. Categories
3.1. List categories — GET /v1/ats/categories
3.2. Show a category — GET /v1/ats/categories/:id
4. Tickets
4.1. Ticket resource fields
4.2. List tickets — GET /v1/ats/tickets
4.3. Show a ticket — GET /v1/ats/tickets/:id
4.4. Create a ticket — POST /v1/ats/tickets
4.5. Update a ticket — PATCH /v1/ats/tickets/:id
4.6. Delete a ticket — DELETE /v1/ats/tickets/:id
5. Posts (replies)
5.1. Post resource fields
5.2. List posts
5.3. Show a post — GET /v1/ats/posts/:id
5.4. Create a post (reply) — POST /v1/ats/tickets/:ticket_id/posts
5.5. Update a post — PATCH /v1/ats/posts/:id
5.6. Delete a post — DELETE /v1/ats/posts/:id
6. Attachments
6.1. Attachment resource fields
6.2. List attachments
6.3. Show an attachment — GET /v1/ats/attachments/:id
6.4. Upload an attachment — POST /v1/ats/posts/:post_id/attachments
6.5. Download an attachment — GET /v1/ats/attachments/:id/download
6.6. Delete an attachment — DELETE /v1/ats/attachments/:id
7. Manager notes
7.1. Manager note resource fields
7.2. List manager notes
7.3. Show a manager note — GET /v1/ats/notes/:id
7.4. Create a manager note — POST /v1/ats/tickets/:ticket_id/notes
7.5. Update a manager note — PATCH /v1/ats/notes/:id
7.6. Delete a manager note — DELETE /v1/ats/notes/:id
8. Endpoint summary

Note

This feature is only available in Akeeba Ticket System Professional.

Akeeba Ticket System provides a REST API built on Joomla's API application, following the JSON:API 1.0 specification. External systems — such as CRM tools, helpdesk dashboards, chatbots, or custom automation — can use it to manage ATS tickets, posts, attachments, and manager notes programmatically.

1.Requirements and setup

The following steps are required before making any API call.

  1. Install Akeeba Ticket System Professional. The API integration is a Pro-only feature. The plugin that registers the API routes (plg_webservices_ats) is only shipped with and installed by the Pro package.

  2. Enable the "Web Services - Akeeba Ticket System" plugin. Go to System → Plugins, search for Akeeba Ticket System, and publish the plugin whose type is Web Services. Without this plugin the API routes are not registered and every request returns a 404 response.

  3. Create a Joomla API token for an ATS manager account. In the Joomla Administrator, open the user account that will be used to authenticate API calls. In the Joomla API Token tab, enable and copy the token. The user account must be an ATS manager in at least one ticket category; every ATS API endpoint enforces this check and rejects non-managers with a 403 response.

PrevUpNext
3.CRON commandsHome2.API conventions