headless lms
Communities

Open message flags in a community (staff)

GET /api/communities/{communityId}/message-queue. Open message flags in a community (staff). Headless LMS Communities API reference.

GET
/api/communities/{communityId}/message-queue

Staff only (owner, admin, instructor). The messages in the community's chats with open flags, with the flags and the chat each is in. Holds at most the 100 oldest open flags; working the queue brings in the next ones.

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/communities/string/message-queue"
{  "entries": [    {      "message": {        "orgId": "string",        "id": "string",        "communityId": "string",        "chatId": "string",        "orgUserId": "string",        "body": "string",        "replyToId": "string",        "editedAt": "2019-08-24T14:15:22Z",        "deletedAt": "2019-08-24T14:15:22Z",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "sender": {          "id": "string",          "firstName": "string",          "lastName": "string",          "displayName": "string",          "headline": "string",          "image": "string",          "imageAssetId": "string",          "imageUrl": "string",          "role": "owner"        },        "attachments": [          {            "assetId": "string",            "url": "string"          }        ],        "reactions": {          "property1": 0,          "property2": 0        },        "viewerReaction": "string"      },      "flags": [        {          "orgId": "string",          "id": "string",          "communityId": "string",          "messageId": "string",          "orgUserId": "string",          "reason": "string",          "resolvedAt": "2019-08-24T14:15:22Z",          "resolution": "dismissed",          "resolvedBy": "string",          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ],      "chat": {        "orgId": "string",        "id": "string",        "communityId": "string",        "kind": "direct",        "status": "pending",        "createdBy": "string",        "lockedAt": "2019-08-24T14:15:22Z",        "lockedBy": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      },      "participantIds": [        "string"      ]    }  ]}
{  "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"}

Staff analytics for a community GET

GET /api/communities/{communityId}/analytics. Staff analytics for a community. Headless LMS Communities API reference.

List the spaces in a community (staff) GET

GET /api/communities/{communityId}/spaces. List the spaces in a community (staff). Headless LMS Communities API reference.