Sign in

v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
Documents

Get document permissions

Returns the document-level ability values (the Share dialog "Abilities" toggles), plus the resolved permits for a specific user when userId is provided.

get/api/v1/documents/{identifier}/permissions

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Document identifier (either document ID or identifier slug)

Query parameters

userIdstring uuid

User membership ID to check permissions for. When omitted, only the document-level abilities are returned.

User membership ID to check permissions for. When omitted, only the document-level abilities are returned.

Response

Document abilities, plus user permits when userId is provided

{"stackTrail":"components:schemas:DocumentsGetPermissionsResponse:properties:permits","oasType":"schema","type":"unknown","description":"User permits for the document. Present only when userId is provided."}