PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List sites GETCreate a site POSTGet a site GETUpdate a site PATCHDelete a site DELETEPublish a site POSTUnpublish a site POSTList pages GETCreate a page POSTGet a page GETUpdate a page PATCHDelete a page DELETEList collections GETCreate a collection POSTGet a collection GETUpdate a collection PATCHDelete a collection DELETEList collection items GETCreate a collection item POSTGet a collection item GETUpdate a collection item PATCHDelete a collection item DELETEPublish collection items POSTUnpublish collection items POSTArchive collection items POSTUpsert collection items POST
Sites

List sites

GET
/sites

Authorization

x-api-key<token>

In: header

Query Parameters

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

Response Body

application/json

curl -X GET "https://example.com/sites"
{  "data": [    {      "id": "string",      "name": "string",      "slug": "string",      "language": "string",      "url": "string",      "theme": {        "background": "string",        "foreground": "string",        "primary": "string",        "primaryForeground": "string",        "muted": "string",        "surface": "string",        "border": "string",        "dark": {          "background": "string",          "foreground": "string",          "primary": "string",          "primaryForeground": "string",          "muted": "string",          "surface": "string",          "border": "string"        },        "defaultMode": "light",        "fontFamily": "string",        "searchEngines": {          "index": true,          "follow": true        }      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "total": 0,    "limit": 0,    "offset": 0  }}

Send a notification to members POST

Requires `COMMUNITY_NOTIFICATIONS_WRITE` and an app caller (`pwa_` secret); workspace API keys get 403. Sends an in-app notification and a push notification to up to 100 members. It never sends email. The title is always the app's name: Planeward sets it, and a `title` in the body is ignored. `href` is a path in the app. Opening the notification opens the app's channel on the community site with the app loaded at that path. Members can turn off an app's notifications. A member who did is still listed in `accepted`, so the app can't tell who muted it. A member gets at most 10 notifications an hour from one app; past that the member is skipped with `over_limit`. Send `key` when you retry: a member the app already sent that `key` in the last 24 hours is listed in `accepted` and not notified again. Without `key`, a retry notifies again. The response is 200 even when every member is skipped.

Create a site POST

Creates the site with an empty homepage.