whiteboards

25 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1

List whiteboards in a space (archived included)#

GET/spaces/{spaceId}/whiteboardsToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create an empty whiteboard#

POST/spaces/{spaceId}/whiteboardsToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonWhiteboardNameDto`

Name	Typ	Beschreibung
`name`Pflicht	`string`	Beispiel: `Sprint retro`

Antworten

201Whiteboard created

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Sprint retro"}'

Get a whiteboard with its scene and image ids#

GET/spaces/{spaceId}/whiteboards/{whiteboardId}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Antworten

404Whiteboard not found

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Rename a whiteboard#

PATCH/spaces/{spaceId}/whiteboards/{whiteboardId}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonWhiteboardNameDto`

Name	Typ	Beschreibung
`name`Pflicht	`string`	Beispiel: `Sprint retro`

Antworten

409Whiteboard is archived

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Sprint retro"}'

Permanently delete a whiteboard and its images#

DELETE/spaces/{spaceId}/whiteboards/{whiteboardId}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

The caller's Share state on a whiteboard (restricted, own caps)#

GET/spaces/{spaceId}/whiteboards/{whiteboardId}/accessToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/access" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Archive a whiteboard (read-only until restored)#

POST/spaces/{spaceId}/whiteboards/{whiteboardId}/archiveToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/archive" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Owner, dates, labels and stats of a whiteboard#

GET/spaces/{spaceId}/whiteboards/{whiteboardId}/detailsToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/details" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Store an image embedded in the whiteboard#

POST/spaces/{spaceId}/whiteboards/{whiteboardId}/filesToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Request-Body`multipart/form-data`

Name	Typ	Beschreibung
`fileId`Pflicht	`string`	Excalidraw FileId
`file`Pflicht	`string (binary)`	–

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/files" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -F "file=@./datei.pdf"

Download an embedded image#

GET/spaces/{spaceId}/whiteboards/{whiteboardId}/files/{fileId}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–
`fileId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/files/{fileId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

The space's labels (shared with wiki pages)#

GET/spaces/{spaceId}/whiteboards/{whiteboardId}/label-optionsToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/label-options" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a space label (or return the one with that name)#

POST/spaces/{spaceId}/whiteboards/{whiteboardId}/label-optionsToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonCreateWikiLabelDto`

Name	Typ	Beschreibung
`name`Pflicht	`string`	Beispiel: `Architecture`
`color`	`string`	Hex color code Standard: `"#6366f1"` Beispiel: `#6366f1`
`description`	`string`	–
`sort_order`	`number`	Standard: `0`

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/label-options" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Architecture"}'

Replace a whiteboard's labels#

PUT/spaces/{spaceId}/whiteboards/{whiteboardId}/labelsToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonSetPageLabelsDto`

Name	Typ	Beschreibung
`label_ids`Pflicht	`string[]`	Complete set of label UUIDs to assign (replaces existing)

Antworten

409WHITEBOARD_ARCHIVED

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/labels" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"label_ids":[]}'

Token for the board's private live channels (presence, cursors, scene)#

POST/spaces/{spaceId}/whiteboards/{whiteboardId}/live/tokenToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/live/token" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Transfer a whiteboard to another space member#

POST/spaces/{spaceId}/whiteboards/{whiteboardId}/ownerToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonTransferWhiteboardOwnerDto`

Name	Typ	Beschreibung
`user_id`Pflicht	`string`	public.users.id of the new owner

Antworten

403Not the owner or an admin

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/owner" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"user_id":"…"}'

Whether private mode is on for the board#

GET/spaces/{spaceId}/whiteboards/{whiteboardId}/private-modeToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/private-mode" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

End private mode for everyone on the board#

POST/spaces/{spaceId}/whiteboards/{whiteboardId}/private-mode/endToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/private-mode/end" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Start private mode for everyone on the board#

POST/spaces/{spaceId}/whiteboards/{whiteboardId}/private-mode/startToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonStartPrivateModeDto`

Name	Typ	Beschreibung
`keep_anonymous`Pflicht	`boolean`	Keep authors anonymous after the session ends

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/private-mode/start" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"keep_anonymous":true}'

Restore an archived whiteboard#

POST/spaces/{spaceId}/whiteboards/{whiteboardId}/restoreToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/restore" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Autosave the scene (optimistic lock on base_revision)#

PUT/spaces/{spaceId}/whiteboards/{whiteboardId}/sceneToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonSaveWhiteboardSceneDto`

Name	Typ	Beschreibung
`elements`Pflicht	`object[]`	–
`app_state`Pflicht	`object`	–
`base_revision`Pflicht	`number`	The revision this scene was based on (optimistic lock)

Antworten

409WHITEBOARD_REVISION_CONFLICT or WHITEBOARD_ARCHIVED
413WHITEBOARD_TOO_LARGE

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/scene" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"elements":[],"app_state":{},"base_revision":0}'

The board's shared timer (with the server time)#

GET/spaces/{spaceId}/whiteboards/{whiteboardId}/timerToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/timer" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Start, set the time of, pause, resume, stop or +1 min the timer#

POST/spaces/{spaceId}/whiteboards/{whiteboardId}/timerToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonTimerCommandDto`

Name	Typ	Beschreibung
`action`Pflicht	`string`	Werte: `startsetpauseresumestopadd_minute`
`duration_ms`	`number`	Required for start and set (the time typed on the card); optional for resume (resume with an edited time)

Antworten

409Whiteboard is archived

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/timer" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action":"start"}'

Version history of a whiteboard (newest first, no scenes)#

GET/spaces/{spaceId}/whiteboards/{whiteboardId}/versionsToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/versions" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

One version of a whiteboard, with its scene#

GET/spaces/{spaceId}/whiteboards/{whiteboardId}/versions/{version}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–
`version`Pflicht	Pfad	`number`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/versions/{version}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Restore a version of the scene and name as a new revision#

POST/spaces/{spaceId}/whiteboards/{whiteboardId}/versions/{version}/restoreToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`whiteboardId`Pflicht	Pfad	`string`	–
`version`Pflicht	Pfad	`number`	–

Antworten

409WHITEBOARD_ARCHIVED, or still racing autosaves

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/whiteboards/{whiteboardId}/versions/{version}/restore" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

whiteboards

List whiteboards in a space (archived included)#

Parameter

Antworten

Create an empty whiteboard#

Parameter

Request-Bodyapplication/jsonWhiteboardNameDto

Antworten

Get a whiteboard with its scene and image ids#

Parameter

Antworten

Rename a whiteboard#

Parameter

Request-Bodyapplication/jsonWhiteboardNameDto

Antworten

Permanently delete a whiteboard and its images#

Parameter

Antworten

The caller's Share state on a whiteboard (restricted, own caps)#

Parameter

Antworten

Archive a whiteboard (read-only until restored)#

Parameter

Antworten

Owner, dates, labels and stats of a whiteboard#

Parameter

Antworten

Store an image embedded in the whiteboard#

Parameter

Request-Bodymultipart/form-data

Antworten

Download an embedded image#

Parameter

Antworten

The space's labels (shared with wiki pages)#

Parameter

Antworten

Create a space label (or return the one with that name)#

Parameter

Request-Bodyapplication/jsonCreateWikiLabelDto

Antworten

Replace a whiteboard's labels#

Parameter

Request-Bodyapplication/jsonSetPageLabelsDto

Antworten

Token for the board's private live channels (presence, cursors, scene)#

Parameter

Antworten

Transfer a whiteboard to another space member#

Parameter

Request-Bodyapplication/jsonTransferWhiteboardOwnerDto

Antworten

Whether private mode is on for the board#

Parameter

Antworten

End private mode for everyone on the board#

Parameter

Antworten

Start private mode for everyone on the board#

Parameter

Request-Bodyapplication/jsonStartPrivateModeDto

Antworten

Restore an archived whiteboard#

Parameter

Antworten

Autosave the scene (optimistic lock on base_revision)#

Parameter

Request-Bodyapplication/jsonSaveWhiteboardSceneDto

Antworten

The board's shared timer (with the server time)#

Parameter

Antworten

Start, set the time of, pause, resume, stop or +1 min the timer#

Parameter

Request-Bodyapplication/jsonTimerCommandDto

Antworten

Version history of a whiteboard (newest first, no scenes)#

Parameter

Antworten

One version of a whiteboard, with its scene#

Request-Body`application/jsonWhiteboardNameDto`

Request-Body`application/jsonWhiteboardNameDto`

Request-Body`multipart/form-data`

Request-Body`application/jsonCreateWikiLabelDto`

Request-Body`application/jsonSetPageLabelsDto`

Request-Body`application/jsonTransferWhiteboardOwnerDto`

Request-Body`application/jsonStartPrivateModeDto`

Request-Body`application/jsonSaveWhiteboardSceneDto`

Request-Body`application/jsonTimerCommandDto`