Joomla Web Services API

The built-in Joomla Web Services API provides RESTful JSON endpoints for managing articles, categories, contacts, banners, menus, modules, tags, custom fields, and user accounts in a Joomla installation. Authentication uses Bearer tokens issued per-user. The API is available in Joomla 4.x and later and follows the {base_url}/api/index.php/v1/ URL pattern.

API entry from apis.yml

apis.yml Raw ↑
aid: joomla:joomla-web-services-api
name: Joomla Web Services API
description: 'The built-in Joomla Web Services API provides RESTful JSON endpoints for managing articles,
  categories, contacts, banners, menus, modules, tags, custom fields, and user accounts in a Joomla installation.
  Authentication uses Bearer tokens issued per-user. The API is available in Joomla 4.x and later and
  follows the {base_url}/api/index.php/v1/ URL pattern.

  '
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
humanURL: https://docs.joomla.org/J4.x:Joomla_Core_APIs
baseURL: https://{your-joomla-site}/api/index.php/v1
tags:
- Articles
- Categories
- Contacts
- Banners
- Menus
- Modules
- Users
- Tags
- Fields
properties:
- type: Documentation
  url: https://docs.joomla.org/J4.x:Joomla_Core_APIs
- type: Specification
  url: https://docs.joomla.org/Joomla_Api_Specification
contact:
- FN: Joomla Developer Community
  url: https://developer.joomla.org
  email: ''