API to create and get Joomla categories
GET /index.php?option=com_api&app=categories&resource=category&format=raw&id=:id
Alternatively, you can call this API as follow (assuming you have created a menu with alias as 'api' for com_api)
GET /api/categories/category/:id
| Param Name |
Required |
Comment |
| fields |
NO |
Defaults to id, title, created_time |
| Param Name |
Comment |
| success |
true if the API call succeeds, false if there was a problem |
| message |
Error mesage in case success is false |
| data.results |
Array containing a single Category Object in case of success. Empty array in case of failure. |
GET /index.php?option=com_api&app=categories&resource=categories&format=raw
Alternatively, you can call this API as follow (assuming you have created a menu with alias as 'api' for com_api)
GET /api/categories/categories
| Param Name |
Required |
Comment |
| limit |
NO |
Defaults to 20 |
| limitstart |
NO |
Defaults to 0 |
| search |
NO |
search key for searching category titles |
| filters[access] |
NO |
Access level |
| filters[extension] |
NO |
Defaults to 'com_content' |
| filters[language] |
NO |
eg: hi-IN for Hindi |
| filters[level] |
NO |
eg: 1 for top level |
| filters[published] |
NO |
1 / 0, defaults to 1 |
| fields (not implemented yet) |
NO |
Defaults to id, title, created_time |
| Param Name |
Comment |
| success |
true if the API call succeeds, false if there was a problem |
| message |
Error mesage in case success is false |
| data.results |
Array of Category Objects in case of success. Empty array in case of failure. |
POST /index.php?option=com_api&app=categories&resource=categories&format=raw
OR update an existing category
POST /index.php?option=com_api&app=categories&resource=categories&format=raw&id=:id
| Param Name |
Required |
Type |
Comment |
| title |
YES |
STRING |
|
| alias |
NO |
STRING |
URL alias. Will be generated based on title if kept empty |
| description |
NO |
STRING |
|
| published |
NO |
INT |
1 = Published (Default) / 0 = Unpublished |
| parent_id |
NO |
INT |
Specify a parent category id if you wish to create a subcategory |
| language |
NO |
STRING |
Will use the site's default language if none provided. |
| extension |
YES |
STRING |
Since Joomla supports using the categories extension for 3rd party components, this field specifies the extension name. Use com_content for article categories. |
| access |
NO |
INT |
Access Level for Category |
| Param Name |
Comment |
| success |
true if the category was created, false if there was a problem |
| message |
Error mesage in case success is false |
| data.results |
Array containing a single Category Object in case of success. Empty array in case of failure. |
The actual contents of the category object will vary based on which fields are requested, however the below is the list of all possible fields.
{
"id" : "",
"title" : "",
"alias" : "",
"description" : "",
"published" : "",
"created_time" : "",
"modified_time" : "",
"access" : "",
"language" : "",
"created_user_id": {
"id" : "",
"name" : "",
"avatar" : ""
},
"language" : ""
}