HumHub - Content API (1.0.0)

Download OpenAPI specification:Download

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

Welcome to the HumHub content module API reference.

Authentication

Bearer

Security Scheme Type JWT

BasicAuth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Content

API to access and manage content information.

Find all content by container

path Parameters
id
required
integer

The id of the content 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.

orderBy
string
Default: "creationTime"
Enum: "creationTime" "lastUpdate"

Order by:

  • creationTime - Descending, from most recently created
  • lastUpdate - Descending, from last updated
dateUpdatedFrom
string
Examples:
  • dateUpdatedFrom=2021-01-01 11:00:00 - Value can be a date string.
  • dateUpdatedFrom=1609498800 - Value can be a unix timestamp.

Filter by latest update time from date.

dateUpdatedTo
string
Examples:
  • dateUpdatedTo=2022-01-01 11:00:00 - Value can be a date string.
  • dateUpdatedTo=1641034800 - Value can be a unix timestamp.

Filter by latest update time until date.

Responses

Response samples

Content type
application/json
{
  • "total": 76,
  • "page": 1,
  • "pages": 8,
  • "links": {
    },
  • "results": []
}

Get content by id

path Parameters
id
required
integer

The id of the content

Responses

Response samples

Content type
application/json
{}

Deletes a content by id

path Parameters
id
required
integer

The id of content

Responses

Container

API to access and manage content containers.

Find all content 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
application/json
{
  • "total": 76,
  • "page": 1,
  • "pages": 8,
  • "links": {
    },
  • "results": [
    ]
}

Tags

Group API