Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Folder

Get folder by id

Returns a specific folder.

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

get/folders/{id}

Path parameters

idinteger required

The ID of the folder to be returned.

Query parameters

include-collaboratorsboolean

Includes collaborators on the folder.

include-direct-childrenboolean

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

include-operationsboolean

Includes operations associated with this folder 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 folder 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 folder is returned.

idstring

ID of the folder.

typestring

The content type of the object.

status'current' | 'draft' | 'archived' | 'historical' | 'trashed' | 'deleted' | 'any'

The status of the content.

titlestring

Title of the folder.

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 folder within the given parent page tree.

authorIdstring

The account ID of the user who created this folder.

ownerIdstring

The account ID of the user who owns this folder.

createdAtstring date-time

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

spaceIdstring

ID of the space the folder is in.