Skip to main content

Joomla Webservices API Documentation

Welcome to the technical documentation for the Joomla Webservices API.

What is the Joomla Webservices API?​

The Joomla Webservices API is a RESTful API that provides access to Joomla content and functionality. With this API you can:

  • Manage content (articles, categories, menus)
  • Manage users and permissions
  • Control extensions and modules
  • Create custom endpoints for your application

Key functionalities​

🔐 Authentication​

The API supports various authentication methods:

  • Token-based authentication
  • Basic authentication
  • API Key authentication

📚 Content Management​

Full CRUD operations for:

  • Articles and categories
  • Media files
  • Menu items
  • Custom fields

👥 User Management​

  • Create, update, and delete users
  • Manage groups and access rights
  • User sessions and tokens

Getting Started​

Start with the Installation guide to set up your development environment.

Support​

For questions and support, see the GitLab repository.