Sharing
Who can see a page: grants to people, teamspaces or the whole workspace, restricted pages, and public links.
View as MarkdownEndpoints
- POSTShare a page
/v1/documents/{documentId}/grants - DELStop sharing a page
/v1/documents/{documentId}/grants/{grantId} - POSTShare a page with someone by email
/v1/documents/{documentId}/invite - POSTRestrict or unrestrict a page
/v1/documents/{documentId}/restricted - GETList a page's public links
/v1/documents/{documentId}/share-links - POSTCreate a public link
/v1/documents/{documentId}/share-links - GETGet a page's sharing settings
/v1/documents/{documentId}/sharing - PATCHChange a public link
/v1/share-links/{shareLinkId} - DELRevoke a public link
/v1/share-links/{shareLinkId}
The DocumentGrant object
- documentIdstring
- principalTypestring
One of
userteamspaceworkspace - principalIdstring
- levelstring
One of
viewcommenteditfull - createdAttimestamp
{
"id": "string",
"documentId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
"principalType": "user",
"principalId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
"level": "view",
"createdBy": null,
"createdAt": "2026-11-12T09:30:00.000Z"
}