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 courses

Requires `COURSES_READ` (`COURSE_PROGRESS_WRITE` also works). Published courses members can see (sold through at least one product) in sidebar order, without their outline. `chapterCount` and `moduleCount` skip chapters without modules.

GET
/community/courses

Requires COURSES_READ (COURSE_PROGRESS_WRITE also works). Published courses members can see (sold through at least one product) in sidebar order, without their outline. chapterCount and moduleCount skip chapters without modules.

Authorization

x-api-key<token>

In: header

Query Parameters

limit?integer
Rangevalue <= 100
Default50
offset?integer
Range0 <= value
Default0

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/community/courses"
{  "data": [    {      "id": "string",      "title": "string",      "description": "string",      "position": 0,      "chapterCount": 0,      "moduleCount": 0,      "publishedAt": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "total": 0,    "limit": 0,    "offset": 0  }}

List channels GET

Requires `COMMUNITY_MESSAGES_READ` (`COMMUNITY_MESSAGES_WRITE` also works, so an app that only posts can find a channel). Text and app channels the `@everyone` role can view, after category and channel overwrites, in sidebar order. App channels whose app is uninstalled or no longer available are left out. Private channels are never listed. Returns 403 when the Community module is disabled and 404 when the workspace has no community.

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.