Skip to main content
Version: 6.2.0

Joomla 6.2.0 Core Web Services API

Core Joomla Web Services API routes, authentication, request and response schemas, and form parameters. Check x-support for operation availability. Replace example URLs, tokens and IDs with site values. Installed plugins can extend forms and responses.

Authentication​

Authentication is done using a Joomla API Token, sent as Authorization: Bearer <token> or in the X-Joomla-Token header. To get the token, go to the user profile in your Joomla installation and activate and copy the API key. Basic authentication with username and password only works when its plugin is enabled. The Joomla Update endpoints use the separate X-JUpdate-Token.

Response schemas​

Response schemas and examples are derived from the Joomla source code; they are not captured from a site, unless the example says so.

Components without web services​

  • com_associations supplies administrator tools for multilingual associations. It has no standalone web-services plugin or REST routes in these snapshots.
  • com_finder manages the Smart Search index, maps and filters. It has no core REST search or indexing routes in these snapshots.

Videos​

YouTube playlist about Joomla Web Services / APIs

Authentication​

Joomla API token of a user, sent as Authorization: Bearer <token>. Users get their token on the Joomla API Token tab of their profile. The plugins "API Authentication - Web Services Joomla Token" and "User - Joomla API Token" must be enabled.

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

License