v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Document permissions

Get document permissions

Retrieve the document-level ability values (the Abilities toggles in the document's settings), plus the resolved permits for a specific user when userId is provided.

get/v1/documents/{documentId}/permissions

Path parameters

documentIdstring required

The document identifier. To retrieve the ID, navigate to File > Document settings in the document and then click Settings. The Identifier field contains the document ID.

Query parameters

userIdstring uuid

User membership ID to check permissions for. When omitted, only the document-level abilities are returned. Use the List users and List embed users endpoints to retrieve user IDs.

Response

Document abilities, plus user permits when userId is provided