Get a page's sharing settings
View as MarkdownGET
/v1/documents/{documentId}/sharingdocs:readRead-only
curl "https://api.lydie.co/v1/documents/01JCQ3V5MZ8G4ZK2X7T9R6N1PB/sharing" \
-H "Authorization: Bearer $LYDIE_TOKEN"Path parameters
Response
- documentIdULID
- myLevelstring
One of
viewcommenteditfull - restrictedboolean
- grantsDocumentGrant[]
Grants on this page.
Show 7 fieldsHide fields
- documentIdstring
- principalTypestring
One of
userteamspaceworkspace - principalIdstring
- levelstring
One of
viewcommenteditfull - createdAttimestamp
- inheritedobject[]
Grants on ancestors that apply here, nearest first, up to a restricted page.
Show 3 fieldsHide fields
- documentIdstring
- titlestring
- grantsDocumentGrant[]
Show 7 fieldsHide fields
- documentIdstring
- principalTypestring
One of
userteamspaceworkspace - principalIdstring
- levelstring
One of
viewcommenteditfull - createdAttimestamp
- peopleobject[]
Everyone who can access the page and their resolved level.
{
"documentId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
"myLevel": "view",
"restricted": false,
"teamspaceId": null,
"privateOwnerId": null,
"grants": [
{
"id": "string",
"documentId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
"principalType": "user",
"principalId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
"level": "view",
"createdBy": null,
"createdAt": "2026-11-12T09:30:00.000Z"
}
],
"inherited": [
{
"documentId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
"title": "Meeting notes",
"grants": [
{
"id": null,
"documentId": null,
"principalType": "user",
"principalId": null,
"level": "view",
"createdBy": null,
"createdAt": "2026-11-12T09:30:00.000Z"
}
]
}
],
"people": [
{
"userId": "kG7qL2m9XzP4tR8w",
"name": "Notes",
"email": "ada@example.com",
"level": "view"
}
]
}Errors use one envelope for every endpoint. See Errors and versions.