Documents

Get document permissions

Changed on

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

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/documents/{identifier}/permissions
  • Auth
    HTTP bearer

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Query parameters

userIdstring uuid

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

Response

Document abilities, plus user permits when userId is provided

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      response property permits/items/id deprecated

    • breaking

      the response's property type changed from no type to array for status