Skip to main content
GET
/
v1
/
documents
/
{documentId}
/
permissions
Retrieve document permissions for a user
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions \
  --header 'Authorization: Bearer <token>'
{
  "permits": [
    {
      "description": "Organization",
      "direct": {
        "accessBoost": false,
        "isOwner": false,
        "role": "VIEWER"
      },
      "id": "df290ed4-b721-4efe-914b-95d30ce1c5f2",
      "name": "Organization",
      "type": "user"
    },
    {
      "description": "Organization",
      "folder": {
        "accessBoost": false,
        "isOwner": false,
        "role": "VIEWER"
      },
      "id": "df290ed4-b721-4efe-914b-95d30ce1c5f2",
      "name": "Organization",
      "type": "user"
    }
  ]
}

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>
required

ID of the user to retrieve document permissions for. Use the List users and List embed users endpoints to retrieve user IDs.

Response

Document permissions for the user

​
permits
object[]