HumHub - Topic API (1.0.0)

Download OpenAPI specification:Download

E-mail: info@humhub.com License: AGPLv2

Welcome to the HumHub topic module API reference.

Authentication

Bearer

Security Scheme Type JWT

BasicAuth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Topic

API to access and manage topic information.

Find all topics

query Parameters
page
string >= 0

The number of page of the result set.

limit
string [ 1 .. 50 ]
Default: 20

The numbers of items to return per page.

Responses

Response samples

Content type
{
  • "total": 76,
  • "page": 1,
  • "results": [
    ]
}

Get topic by id

path Parameters
id
required
integer

The id of topic

Responses

Response samples

Content type
{
  • "id": 1,
  • "name": "Api topic"
}

Update existing topic

path Parameters
id
required
integer

The id of topic

Request Body schema: application/json

Topic name

name
string

Responses

Request samples

Content type
application/json
{
  • "name": "Api topic"
}

Response samples

Content type
{
  • "id": 1,
  • "name": "Api topic"
}

Delete topic by id

path Parameters
id
required
integer

The id of topic

Responses

Response samples

Content type
{
  • "code": 200,
  • "message": "Topic successfully deleted!"
}

Get all topics by container

path Parameters
containerId
required
integer

The id of container

query Parameters
page
string >= 0

The number of page of the result set.

limit
string [ 1 .. 50 ]
Default: 20

The numbers of items to return per page.

Responses

Response samples

Content type
{
  • "total": 76,
  • "page": 1,
  • "results": [
    ]
}

Create new topic

path Parameters
containerId
required
integer

The id of container

Request Body schema: application/json

Topic info

name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Api topic"
}

Response samples

Content type
{
  • "id": 1,
  • "name": "Api topic"
}