{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c678a936-c256-497c-9894-d8f193d81e7e","name":"Joomla Web Services Collection For Postman","description":"## 100+ Endpoints Joomla Web Services Collection For Postman\n\nAn attempt to help the Joomla! 4.x/5.x/6.x early adopters mainly focused for developers. It's an unofficial Postman collection of official Joomla Web Services Specification.\n\n[https://github.com/alexandreelise/j4x-api-collection](https://github.com/alexandreelise/j4x-api-collection) for updates and information.\n\nOr directly ready to use code in your favourite programming language generated by the documentation. Here is the link below\n\n[https://documenter.getpostman.com/view/7443864/2s9YywfKez](https://documenter.getpostman.com/view/7443864/2s9YywfKez)\n\n## Presentation\n\nSlides by Marc DECHÈVRE [https://slides.woluweb.be/api/api.html](https://slides.woluweb.be/api/api.html)\n\n## Installation\n\n- Click on the Run in Postman button above or below in this README\n    \n- Follow the instructions (You should fork the collection in your own postman workspace)\n    \n- You should now have a new collection of endpoints in Postman\n    \n- Click on the collection, then on the ... on the right of the collection to open the settings for the collection\n    \n- Set your own values for Authentication and Variables per the steps below\n    \n- Test a generic GET request from the list to then confirm your authentication is working and your base_url and base_path is set correctly.\n    \n\n## Authentication\n\nAuthentication is done using a Joomla API Token. To get the token, go to your Super User profile in your Joomla 4 Installation and activate then copy the API key. In Postman, edit the Collection and then click on the Authorization tab.\n\n- Select Type = \"API Key\"\n    \n- For the Key field, enter \"X-Joomla-Token\"\n    \n- In the Value field, paste your Joomla API Token\n    \n- For the Add To field, leave the value as \"Header\"\n    \n- Click Update to save the settings or click on Variables tab to modify your Base Path variable.\n    \n\nIf you prefer a video about how to set up your Joomla API Token here is one:\n\n[Short video how to set up Joomla API Token](https://youtube.com/clip/UgkxfHFK1vhr1oCpJvhBWwC8Mvm0LBB2WZ7A?si=nVa8FHGBlBUNxIek)\n\nFull video is :\n\n<video src=\"https://youtube.com/embed/lT9qodsvfZg\" width=\"340\"></video>\n\nJoomla 4 tutorial: Using the Web Services API\n\n## URLs\n\nThe URLs are set via _base_url_ and _base_path_. You should set this variable within your collection.\n\n- Click the 3 dots on the collection.\n    \n- Select Edit.\n    \n- Click on the variables tab.\n    \n- Add (or update) the _base_url_ and _base_path_ variable, setting the Initial Value field to the URL for your Joomla for installation.\n    \n\n## Videos\n\n[YouTube playlist about Joomla Web Services / APIs](https://www.youtube.com/playlist?list=PLsg93PS_2NeL850YZFlAi1Eb7hwxETNkX)\n\n## Setup\n\nYou might want to consider using :\n\n[https://github.com/muhme/joomla-branches-tester](https://github.com/muhme/joomla-branches-tester)\n\n## Feedback\n\n[https://github.com/alexandreelise/j4x-api-collection](https://github.com/alexandreelise/j4x-api-collection) for updates and information.\n\n## Documentation\n\nThe Postman generated API documentation of Joomla! 4.x and above Web Services collection with directly ready to use code in your favourite programming language generated. Here is the link below\n\n[https://documenter.getpostman.com/view/7443864/2s9YywfKez](https://documenter.getpostman.com/view/7443864/2s9YywfKez)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"7443864","team":1026578,"collectionId":"c678a936-c256-497c-9894-d8f193d81e7e","publishedId":"2s9YywfKez","public":true,"publicUrl":"https://documenter-api.postman.tech/view/7443864/2s9YywfKez","privateUrl":"https://go.postman.co/documentation/7443864-c678a936-c256-497c-9894-d8f193d81e7e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"100+ Endpoints Joomla Web Services Collection For Postman\nAn attempt to help the Joomla! 4.x/5.x/6.x early adopters mainly focused for developers. It's an unofficial Postman collection of official Joomla Web Services Specification.\nhttps://github.com/alexandreelise/j4x-api-collection for updates and information.\n"},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-02-06T01:53:30.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"100+ Endpoints Joomla Web Services Collection For Postman\nAn attempt to help the Joomla! 4.x/5.x/6.x early adopters mainly focused for developers. It's an unofficial Postman collection of official Joomla Web Services Specification.\nhttps://github.com/alexandreelise/j4x-api-collection for updates and information.\n"},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Joomla 4 Web Services Environment For Postman","id":"63b1cc08-85f1-4ae9-8260-630f1ce738b0","owner":"7443864","values":[{"key":"base_url","value":"https://example.org","enabled":true,"type":"secret"},{"key":"base_path","value":"api/index.php/v1","enabled":true,"type":"secret"},{"key":"auth_apikey","value":"Paste your Joomla API Token here","enabled":true,"type":"secret"},{"key":"banner_id","value":"{banner_id}","enabled":true,"type":"default"},{"key":"client_id","value":"{client_id}","enabled":true,"type":"default"},{"key":"category_id","value":"{category_id}","enabled":true,"type":"default"},{"key":"contenthistory_id","value":"{contenthistory_id}","enabled":true,"type":"default"},{"key":"component_name","value":"{component_name}","enabled":true,"type":"default"},{"key":"contact_id","value":"{contact_id}","enabled":true,"type":"default"},{"key":"field_id","value":"{field_id}","enabled":true,"type":"default"},{"key":"group_id","value":"{group_id}","enabled":true,"type":"default"},{"key":"article_id","value":"{article_id}","enabled":true,"type":"default"},{"key":"language_id","value":"{language_id}","enabled":true,"type":"default"},{"key":"app","value":"(site|administrator)","enabled":true,"type":"default"},{"key":"lang_code","value":"{lang_code}","enabled":true,"type":"default"},{"key":"constant_id","value":"{constant_id}","enabled":true,"type":"default"},{"key":"menu_id","value":"{menu_id}","enabled":true,"type":"default"},{"key":"menu_item_id","value":"{menu_item_id}","enabled":true,"type":"default"},{"key":"message_id","value":"{message_id}","enabled":true,"type":"default"},{"key":"module_id","value":"{module_id}","enabled":true,"type":"default"},{"key":"feed_id","value":"{feed_id}","enabled":true,"type":"default"},{"key":"request_id","value":"{request_id}","enabled":true,"type":"default"},{"key":"consent_id","value":"{consent_id}","enabled":true,"type":"default"},{"key":"redirect_id","value":"{redirect_id}","enabled":true,"type":"default"},{"key":"tag_id","value":"{tag_id}","enabled":true,"type":"default"},{"key":"template_style_id","value":"{template_style_id}","enabled":true,"type":"default"},{"key":"user_id","value":"{user_id}","enabled":true,"type":"default"},{"key":"article","value":"","enabled":true,"type":"default"},{"key":"articles_filter_category","value":"2","enabled":true,"type":"default"},{"key":"articles_filter_author","value":"","enabled":true,"type":"default"},{"key":"articles_filter_state","value":"1","enabled":true,"type":"default"},{"key":"articles_filter_featured","value":"0","enabled":true,"type":"default"},{"key":"articles_filter_tag","value":"","enabled":true,"type":"default"},{"key":"articles_filter_language","value":"","enabled":true,"type":"default"},{"key":"articles_filter_search","value":"","enabled":true,"type":"default"},{"key":"articles_list_ordering","value":"modified","enabled":true,"type":"default"},{"key":"articles_list_direction","value":"desc","enabled":true,"type":"default"},{"key":"tour_id","value":"","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f0c8a2b34c4528b49d1cbe8ac0677f7d12bcc155663a245210409412d43490d6","favicon":"https://res.cloudinary.com/postman/image/upload/v1638218886/team/cf6tcn0lr8is9n0kwh6g.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Joomla 4 Web Services Environment For Postman","value":"7443864-63b1cc08-85f1-4ae9-8260-630f1ce738b0"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s9YywfKez"}