headless lms
Communities

The spaces a member can see in a community

GET /api/member/communities/{communityId}/home. The spaces a member can see in a community. Headless LMS Communities API reference.

GET
/api/member/communities/{communityId}/home

For a member of the community. Lists its spaces in order. Spaces the viewer can open come back in full; spaces they can see but not open come back locked, with only their name, count, rule and the viewer's standing. A by-invite space the viewer is not invited to or a member of is left out. 404 when the viewer is not a member.

Path Parameters

communityId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/member/communities/string/home"
{  "communityId": "string",  "title": "string",  "description": "string",  "thumbnailUrl": "string",  "dm": {    "enabled": true,    "memberToMember": true,    "memberToStaff": true,    "staffToAnyone": true,    "firstMessageIsRequest": true,    "groupChats": true,    "groupSize": 1  },  "spaces": [    {      "id": "string",      "name": "string",      "memberCount": -9007199254740991,      "accessRule": "all_members",      "standing": "open",      "locked": true    }  ]}
{  "error": "string",  "message": "string",  "requestId": "string",  "issues": [    {      "path": "string",      "message": "string"    }  ]}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}

Unlock a chat (staff) POST

POST /api/communities/{communityId}/chats/{chatId}/unlock. Unlock a chat (staff). Headless LMS Communities API reference.

One space as a member sees it GET

GET /api/member/communities/{communityId}/spaces/{spaceId}. One space as a member sees it. Headless LMS Communities API reference.