Back to overview

RESTful API

Add it on-the-fly to your HumHub by activating it in the Modules menu! ("Administration -> Modules")


RESTful API

Warning: Beta version - API may change in the next releases!

The REST API module provides a generic interface to various subsystems of the HumHub platform.

Requirements

Available endpoints

You can find a full list of available API endpoints in the Usage manual

Installation

After installation make sure to set an API key at Administration -> Modules -> Installed -> Rest API.

Available Endpoints

Following RESTful API endpoints are available.

Base URL:

The base url for all APIs is: https://yourhost/api/v1/

Core APIs:

Module APIs

The folder /docs/htmlcontains HTML rendered documentations for all available API endpoints.

Swagger / OpenAPI 3.0.0

You can find Swagger documentation files in the /docs/swagger directory of this module.

PostMan

/docs/postman contains a PostMan collection with all available requests.

API development

Documentation

To completely adapt the API documentation after a change, the following steps are necessary.

Swagger

The Swagger documentation is located in the folder /docs/swagger, you need to rebuild the html documentation at /docs/html which is based on the Swagger YAML files.

To create a HTML documentation you need to install the redoc-cli NPM package.

Build HTML documentation:

cd docs/swagger
./build-all.sh

PostMan

Also add examples to the PostMan API request collection located in the folder: /docs/postman.

0.1.4 (October 13, 2020)

  • Enh: User new endpoints, find-by-username and find-by-email

0.1.3 (August 5, 2020)

  • Fix: HumHub 1.6 compatibility issues

0.1.2 (January 31, 2020)

  • Enh: Added User group endpoint

0.1.1 (January 17, 2020)

  • Initial release in marketplace
  • Chg: Removed 'members' attribute from 'Space' output object
  • Enh: Added Space Membership Endpoint

0.1.0 (20 December, 2019)

  • Initial release in marketplace
  • Enh: Various new endpoints and features

0.0.1 (Unrelased)

Initial release

Version:
0.1.4 (released 8 days ago)

Publisher:
HumHub GmbH & Co. KG

Compatibility:
HumHub 1.4 - Latest





HumHub Cloud

Free
Install it on-the-fly at the admin panel
in your HumHub hosting instance


HumHub Self-Hosted

Free
Install it on-the-fly at the admin panel
in your HumHub installation