Get document permissions

curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions \
  --header 'Authorization: Bearer <token>'

[
  {
    "role": "VIEWER",
    "accessBoost": true,
    "direct": true,
    "inherited": true
  }
]

GET

documents

{documentId}

permissions

Get document permissions

curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/permissions \
  --header 'Authorization: Bearer <token>'

[
  {
    "role": "VIEWER",
    "accessBoost": true,
    "direct": true,
    "inherited": true
  }
]

Authorization

string

header

required

Use either an Organization API Key or Personal Access Token (PAT). Include in the Authorization header as: Bearer YOUR_TOKEN

documentId

string

required

Document identifier

userId

string<uuid>

required

User ID to check permissions for

Array of permission objects

role

enum<string>

Available options:

VIEWER,

EDITOR,

MANAGER

accessBoost

boolean

direct

boolean

inherited

boolean