v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB

Whiteboard

Get whiteboard by id

Returns a specific whiteboard.

Permissions required: Permission to view the whiteboard and its corresponding space.

get/whiteboards/{id}

Path parameters

idinteger required

The ID of the whiteboard to be returned

Query parameters

include-collaboratorsboolean

Includes collaborators on the whiteboard.

include-direct-childrenboolean

Includes direct children of the whiteboard, as defined in the ChildrenResponse object.

include-operationsboolean

Includes operations associated with this whiteboard in the response, as defined in the Operation object. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-propertiesboolean

Includes content properties associated with this whiteboard in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

Response

Returned if the requested whiteboard is returned.

idstring

ID of the whiteboard.

typestring

The content type of the object.

The status of the content.

titlestring

Title of the whiteboard.

parentIdstring

ID of the parent content, or null if there is no parent content.

parentType'page' | 'whiteboard' | 'database' | 'embed' | 'folder'

Content type of the parent, or null if there is no parent.

positioninteger nullable

Position of the whiteboard within the given parent page tree.

authorIdstring

The account ID of the user who created this whiteboard originally.

ownerIdstring

The account ID of the user who owns this whiteboard.

createdAtstring date-time

Date and time when the whiteboard was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

spaceIdstring

ID of the space the whiteboard is in.