Available Endpoints

Following RESTful API endpoints are available.

Base URL:

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

Core APIs:

• User
• Content
• Post
• Comment
• Like
• Activity
• Authentication
• File
• Notification
• Space
• Content Topics

Module APIs

• Calendar
• CFiles
• Tasks
• Wiki
• Mail

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.3.0 (February 22, 2021)

• Fix #51: Remove group.space_id for compatible with Humhub 1.8

0.2.1 (February 17, 2021)

• Enh #45: Files Endpoint - Don’t require target folder id to create root automatically

0.2.0-beta.1 (November 23, 2020)

• Enh: New Endpoints for Mail module
• Enh: Added permission checks for regular user access
• Fix #42: Activity Module Endpoint
• Fix #43: Swagger doc is incorrect for user "display_name" for User endpoints
• Fix: Renamed "/like/findByRecord" endpoint to "/like/find-by-object"

0.1.4 (October 13, 2020)

• Enh: User new endpoints, find-by-username and find-by-email
• Enh: Added current User details endpoint

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