Skip to main content
GET
Get document permissions

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

documentId
string
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

userId
string<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

abilities
object
required

Document-level ability values, as stored on the document. These settings control what actions users can perform on a document, and correspond to the toggles in the Abilities section of the document's settings.

permits
object[]

User permits for the document. Present only when userId is provided.