JSON API

DOCman comes with a built-in JSON API support based on the JSON API specification v1.0.

Schema

The API is accessible from any DOCman menu item on your website, for example: https://www.example.com/downloads. Throughout our documentation we'll use https://demo.joomlatools.com/en/docman/hierarchical-list as reference

The API can only access the categories and documents that are accessible through the menu item.

Accept header

All data is sent and received as JSON, set the Accept request-header:

Accept: application/json

Query string

By adding format=json to the query string the representation will always be JSON data.

Example: https://demo.joomlatools.com/en/docman/hierarchical-list?format=json