OMomni
Document permissions

List all users and groups with document access

Changed on

List all users and groups with access to a document.

The paginated response includes a list of principal objects, where each entry represents a distinct access grant with its own role and settings. A principal may appear twice in the response if they have both direct access and folder-based access to the same document.

get/v1/documents/{documentId}/access-list

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/documents/{documentId}/access-list
  • Auth
    HTTP bearer

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

pageSizeinteger

Number of results per page (1-100).

cursorstring

Pagination cursor from a previous response's pageInfo.nextCursor.

sortField'name' | 'email' | 'role'

Field to sort results by.

sortDirection'asc' | 'desc'

Sort order.

accessSource'direct' | 'folder'

Filter by how access was granted:

  • direct — Only principals with explicit document permissions
  • folder — Only principals with inherited folder permissions
type'user' | 'userGroup'

Filter by principal type:

  • user — Only individual users
  • userGroup — Only user groups

Response

Successfully retrieved access list

Changes

  • 43290040f88fRevision changes
    • warning

      added the new OWNER enum value to the // response property for the response status

    • 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 principals/items/id deprecated