HumHub - Space API (1.0.0)

Download OpenAPI specification:Download

Welcome to the HumHub space module API reference.

Space

API to access and manage space information.

Find all spaces

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": 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/",
"contentcontainer_id": 1,
"visibility": 1,
"join_policy": 1,
"status": 1,
"tags": ["First tag",
"Second tag"
],
"owner": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"hideMembers": 1,
"hideAbout": 0,
"hideActivities": 1,
"hideFollowers": 0,
"indexUrl": "/s/welcome-space/space/space/home",
"indexGuestUrl": "/s/welcome-space/space/space/home"
}
]
}

Create new space

Request Body schema: application/json

Space base info and visibility settings

name required	string
description	string
visibility required	integer <int64>
join_policy required	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"name": "Welcome space",
"description": "Your first sample space to discover the platform.",
"visibility": 1,
"join_policy": 1
}

Response samples

200
401
500

Content type

application/json

{"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/",
"contentcontainer_id": 1,
"visibility": 1,
"join_policy": 1,
"status": 1,
"tags": ["First tag",
"Second tag"
],
"owner": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"hideMembers": 1,
"hideAbout": 0,
"hideActivities": 1,
"hideFollowers": 0,
"indexUrl": "/s/welcome-space/space/space/home",
"indexGuestUrl": "/s/welcome-space/space/space/home"
}

Get space by id

path Parameters

id

required

integer

The id of space

Responses

Response samples

200
400
404

Content type

application/json

{"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/",
"contentcontainer_id": 1,
"visibility": 1,
"join_policy": 1,
"status": 1,
"tags": ["First tag",
"Second tag"
],
"owner": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"hideMembers": 1,
"hideAbout": 0,
"hideActivities": 1,
"hideFollowers": 0,
"indexUrl": "/s/welcome-space/space/space/home",
"indexGuestUrl": "/s/welcome-space/space/space/home"
}

Update existing space

path Parameters

id

required

integer

The id of space

Request Body schema: application/json

Space base info and settings

name	string
description	string
tagsField	Array of strings
color	string
url	string
visibility	integer <int64>
join_policy	integer <int64>
default_content_visibility	integer <int64>
hideMembers	boolean
hideAbout	boolean
hideActivities	boolean
hideFollowers	boolean
indexUrl	string
indexGuestUrl	string

Responses

Request samples

Payload

Content type

application/json

{"name": "Welcome space",
"description": "Your first sample space to discover the platform.",
"tagsField": ["First tag",
"Second tag"
],
"color": "#eeeeee",
"url": "welcome-space",
"visibility": 1,
"join_policy": 1,
"default_content_visibility": 1,
"hideMembers": true,
"hideAbout": false,
"hideActivities": true,
"hideFollowers": false,
"indexUrl": "/s/welcome-space/space/space/home",
"indexGuestUrl": "/s/welcome-space/space/space/home"
}

Response samples

200
401
404
500

Content type

application/json

{"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/",
"contentcontainer_id": 1,
"visibility": 1,
"join_policy": 1,
"status": 1,
"tags": ["First tag",
"Second tag"
],
"owner": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"hideMembers": 1,
"hideAbout": 0,
"hideActivities": 1,
"hideFollowers": 0,
"indexUrl": "/s/welcome-space/space/space/home",
"indexGuestUrl": "/s/welcome-space/space/space/home"
}

Delete space by id

path Parameters

id

required

integer

The id of space

Responses

Response samples

200
401
404
500

Content type

application/json

{"code": 200,
"message": "Space successfully deleted!"
}

Archive space

API to archive or unarchive the space.

Archive the space by id

path Parameters

id

required

integer

The id of space

Responses

Response samples

200
400
401
404

Content type

application/json

{"code": 200,
"message": "Space successfully archived!"
}

Unarchive the space by id

path Parameters

id

required

integer

The id of space

Responses

Response samples

200
400
401
404

Content type

application/json

{"code": 200,
"message": "Space successfully unarchived!"
}

Membership

List all memberships by given space id

path Parameters

id

required

integer

The id of space

Responses

Response samples

200
400
404

Content type

application/json

{"total": 76,
"page": 1,
"results": [{"role": "member",
"status": 3,
"can_cancel_membership": false,
"send_notifications": false,
"show_at_dashboard": false,
"originator_user": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"member_since": "2019-12-01 11:43:16",
"request_message": "Please add me to this space!",
"updated_at": "2019-12-30 11:00:59",
"last_visit": "2020-01-15 14:00:59",
"user": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
}
}
]
}

Add a new user to the space

path Parameters

id required	integer The id of space
userId required	integer The id of user

query Parameters

silent

boolean

Default: false

Send added notification to the user

Responses

Delete a space membership of a user

path Parameters

id required	integer The id of space
userId required	integer The id of user

Responses

Set the user membership role

path Parameters

id required	integer The id of space
userId required	integer The id of user

Request Body schema: application/json

Space membership role

role	string admin, member or moderator

Responses

Request samples

Payload

Content type

application/json

{"role": "admin"
}

Response samples

200
400
404

Content type

application/json

{"code": 200,
"message": "Member updated!"
}