Documents
Pages in a workspace: a tree of documents, each with a title, typed properties (frontmatter) and a Markdown body.
View as MarkdownEndpoints
- POSTCreate a document
/v1/documents - GETGet a document
/v1/documents/{id} - DELDelete a document
/v1/documents/{id} - GETList backlinks
/v1/documents/{id}/backlinks - GETList backlinks to a block
/v1/documents/{id}/blocks/{blockId}/backlinks - PATCHUpdate a document body
/v1/documents/{id}/body - GETList outgoing links
/v1/documents/{id}/links - POSTMove a document
/v1/documents/{id}/move - PATCHSet document properties
/v1/documents/{id}/properties - POSTPermanently delete a document
/v1/documents/{id}/purge - POSTRename a document
/v1/documents/{id}/rename - POSTRestore a deleted document
/v1/documents/{id}/restore - POSTMove a page to another teamspace or to Private
/v1/documents/{id}/space - GETList unlinked mentions
/v1/documents/{id}/unlinked-mentions - GETList a document's versions
/v1/documents/{id}/versions - GETGet a document version
/v1/documents/{id}/versions/{versionId} - POSTRestore a document version
/v1/documents/{id}/versions/{versionId}/restore - GETList a document's children
/v1/workspaces/{workspaceId}/children - GETSearch documents
/v1/workspaces/{workspaceId}/search - GETList the document tree
/v1/workspaces/{workspaceId}/tree - GETList unresolved links
/v1/workspaces/{workspaceId}/unresolved-links
The Document object
- idULID
- propertiesobject
- createdAttimestamp
- updatedAttimestamp
{
"id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
"workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA",
"parentId": null,
"title": "Meeting notes",
"sortKey": "a0",
"properties": {
"status": "draft"
},
"createdAt": "2026-11-12T09:30:00.000Z",
"updatedAt": "2026-11-12T09:30:00.000Z",
"deletedAt": null,
"createdBy": null,
"updatedBy": null
}