PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List an embed user's projects GETMint an embed session POST
Embed

List an embed user's projects

Returns non-archived projects owned by the host-site user, with each project's statuses. Requires `EMBED_WRITE`. An unknown `externalUserId` returns an empty list and `embedUser: null`. Creating a task still uses `POST /projects/{projectId}/tasks` and `TASKS_WRITE`.

GET
/embed/projects

Returns non-archived projects owned by the host-site user, with each project's statuses. Requires EMBED_WRITE. An unknown externalUserId returns an empty list and embedUser: null. Creating a task still uses POST /projects/{projectId}/tasks and TASKS_WRITE.

Authorization

x-api-key<token>

In: header

Query Parameters

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

Response Body

application/json

curl -X GET "https://example.com/embed/projects?externalUserId=string"
{  "data": [    {      "id": "string",      "name": "string",      "description": "string",      "statuses": [        {          "id": "string",          "name": "string",          "type": "TODO",          "rank": "string"        }      ]    }  ],  "embedUser": {    "id": "string",    "externalUserId": "string",    "displayName": "string",    "email": "[email protected]"  },  "meta": {    "total": 0,    "limit": 0,    "offset": 0  }}

Delete a message DELETE

Previous Page

Mint an embed session POST

Upserts the host-site end-user and returns a short-lived token plus an iframe URL. Requires the `EMBED_WRITE` scope. Embed must be enabled with at least one allowed origin.