PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List community members GETGet a community member GETList messages in a channel GETPost a message as the app POSTList channels GETList courses GETGet a course outline GETList a member's course progress GETUncomplete a module for a member DELETEComplete a module for a member PUTList the app's badges GETCreate or update a badge by key POSTUpdate a badge PATCHDelete a badge DELETERevoke a badge from a member DELETEAward a badge to a member PUTSend a notification to members POST
Community

List a member's course progress

Requires `COURSES_READ` (`COURSE_PROGRESS_WRITE` also works). One row per module the member has started or completed, in courses members can see (published and sold through at least one product, as `GET /community/courses` lists them). Filter with `courseId`; any other course is 404.

GET
/community/members/{memberId}/progress

Requires COURSES_READ (COURSE_PROGRESS_WRITE also works). One row per module the member has started or completed, in courses members can see (published and sold through at least one product, as GET /community/courses lists them). Filter with courseId; any other course is 404.

Authorization

x-api-key<token>

In: header

Path Parameters

memberId*string

Community membership id

Query Parameters

courseId?string

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/community/members/string/progress"
{  "data": [    {      "memberId": "string",      "moduleId": "string",      "chapterId": "string",      "courseId": "string",      "completedAt": "2019-08-24T14:15:22Z",      "videoPositionSeconds": 0    }  ]}

Get a course outline GET

Requires `COURSES_READ` (`COURSE_PROGRESS_WRITE` also works). The published course with its chapters and modules in order. Chapters without modules are left out, as members see them. Module bodies, videos and attachments are not included. Unpublished courses, and courses not sold through any product, are 404.

Uncomplete a module for a member DELETE

Requires `COURSE_PROGRESS_WRITE`. Clears `completedAt` and keeps the video position. Safe to repeat. The member must be `ACTIVE`.