v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB

Database

Get database by id

Returns a specific database.

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

get/databases/{id}

Path parameters

idinteger required

The ID of the database to be returned

Query parameters

include-collaboratorsboolean

Includes collaborators on the database.

include-direct-childrenboolean

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

include-operationsboolean

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

idstring

ID of the database.

typestring

The content type of the object.

The status of the content.

titlestring

Title of the database.

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

authorIdstring

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

ownerIdstring

The account ID of the user who owns this database.

createdAtstring date-time

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

spaceIdstring

ID of the space the database is in.