Mint an embed session
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.
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.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/embed/sessions" \ -H "Content-Type: application/json" \ -d '{ "externalUserId": "string" }'{ "data": { "token": "string", "embedUrl": "http://example.com", "expiresAt": "2019-08-24T14:15:22Z" }}List an embed user's projects GET
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`.
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.
Planeward Docs