HumHub - Activity API (1.0.0)

Download OpenAPI specification:Download

Welcome to the HumHub activity module API reference.

Activity

API to access activity information.

Find all global activity

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

200

Content type

application/json

{"total": 76,
"page": 1,
"pages": 8,
"links": {"self": "{endpoint_path}?page=1&per-page=10",
"next": "{endpoint_path}?page=2&per-page=10",
"last": "{endpoint_path}?page=8&per-page=10"
},
"results": [{"id": 32,
"class": "humhub\\modules\\space\\activities\\MemberAdded",
"content": {"id": 12,
"guid": "3c66dc40-6157-4b9e-a3cd-b2bdba69614d",
"pinned": false,
"archived": false,
"output": "<strong>John Smith</strong> joined the space <strong>Welcome Space</strong>"
},
"originator": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"source": {"id": 1,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"name": "Welcome Space",
"description": "Your first sample space to discover the platform.",
"url": "http://humhub.localhost/s/welcome-space/"
},
"createdAt": "2019-03-05 15:35:02"
}
]
}

Get activity by id

path Parameters

id

required

integer

The id of activity

Responses

Response samples

200
404

Content type

application/json

{"id": 32,
"class": "humhub\\modules\\space\\activities\\MemberAdded",
"content": {"id": 12,
"guid": "3c66dc40-6157-4b9e-a3cd-b2bdba69614d",
"pinned": false,
"archived": false,
"output": "<strong>John Smith</strong> joined the space <strong>Welcome Space</strong>"
},
"originator": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"source": {"id": 1,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"name": "Welcome Space",
"description": "Your first sample space to discover the platform.",
"url": "http://humhub.localhost/s/welcome-space/"
},
"createdAt": "2019-03-05 15:35:02"
}

Get all activities 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

200

Content type

application/json

{"total": 76,
"page": 1,
"pages": 8,
"links": {"self": "{endpoint_path}?page=1&per-page=10",
"next": "{endpoint_path}?page=2&per-page=10",
"last": "{endpoint_path}?page=8&per-page=10"
},
"results": [{"id": 32,
"class": "humhub\\modules\\space\\activities\\MemberAdded",
"content": {"id": 12,
"guid": "3c66dc40-6157-4b9e-a3cd-b2bdba69614d",
"pinned": false,
"archived": false,
"output": "<strong>John Smith</strong> joined the space <strong>Welcome Space</strong>"
},
"originator": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"source": {"id": 1,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"name": "Welcome Space",
"description": "Your first sample space to discover the platform.",
"url": "http://humhub.localhost/s/welcome-space/"
},
"createdAt": "2019-03-05 15:35:02"
}
]
}