Read an activity's comments
GET /api/member/activities/{activityId}/comments. Read an activity's comments. Headless LMS Discussion API reference.
For anyone who can open the course: through a grant, or with courses:read on it. Returns the activity's resolved comment settings with the comments; removed comments keep their place without their body.
Path Parameters
activityId*string
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/member/activities/string/comments"{ "config": { "enabled": true, "threaded": true, "requireReview": true, "reactions": true }, "comments": [ { "id": "string", "activityId": "string", "postId": "string", "communityId": "string", "parentId": "string", "author": { "id": "string", "firstName": "string", "lastName": "string", "displayName": "string", "headline": "string", "image": "string", "imageAssetId": "string", "imageUrl": "string", "team": true, "roleName": "string" }, "body": "string", "status": "pending", "removedBy": { "id": "string", "firstName": "string", "lastName": "string", "displayName": "string", "headline": "string", "image": "string", "imageAssetId": "string", "imageUrl": "string", "team": true, "roleName": "string" }, "reactions": { "property1": 0, "property2": 0 }, "viewerReaction": "string", "mentions": [ { "orgUserId": "string", "name": "string" } ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ]}{ "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"}