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

Get a community member

Requires `COMMUNITY_MEMBERS_READ`.

GET
/community/members/{memberId}

Requires COMMUNITY_MEMBERS_READ.

Authorization

x-api-key<token>

In: header

Path Parameters

memberId*string

Community membership id

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/community/members/string"
{  "data": {    "id": "string",    "customerId": "string",    "username": "string",    "displayName": "string",    "avatarUrl": "string",    "status": "ACTIVE",    "accessPlans": [      {        "id": "string",        "name": "string"      }    ],    "roles": [      {        "id": "string",        "name": "string"      }    ],    "badges": [      {        "id": "string",        "appId": "string",        "key": "string",        "name": "string",        "description": "string",        "color": "string",        "iconUrl": "string",        "awardedAt": "2019-08-24T14:15:22Z"      }    ],    "joinedAt": "2019-08-24T14:15:22Z"  }}

List community members GET

Requires `COMMUNITY_MEMBERS_READ`. Members of the workspace's community, oldest first. `search` matches only names the response shows: username and `displayName` (the customer or contact name is searched only when it is the `displayName` fallback). It never matches email addresses. Returns 403 when the Community module is disabled and 404 when the workspace has no community.

List messages in a channel GET

Requires `COMMUNITY_MESSAGES_READ` (`COMMUNITY_MESSAGES_WRITE` alone is not enough). Newest first, with reaction counts. Only channels `@everyone` can view; others are 404 "Channel not found." so private channels look missing. Deleted messages are left out. Page with `cursor`: pass the previous response's `meta.nextCursor` until it is null.