Skip to main content
GET
/
v1
/
documents
/
{documentId}
/
access-list
List all users and groups with document access
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/access-list \
  --header 'Authorization: Bearer <token>'
{
  "principals": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Jane Smith",
      "email": "[email protected]",
      "type": "user",
      "role": "EDITOR",
      "accessBoost": false,
      "accessSource": "direct",
      "isOwner": false
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "name": "John Doe",
      "email": "[email protected]",
      "type": "user",
      "role": "VIEWER",
      "accessBoost": false,
      "accessSource": "folder",
      "isOwner": false,
      "folderInfo": {
        "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
        "name": "Marketing Reports",
        "path": "/Shared/Marketing Reports"
      }
    },
    {
      "id": "d4e5f6a7-b8c9-0123-def0-456789012345",
      "name": "Data Analysts",
      "type": "userGroup",
      "role": "VIEWER",
      "accessBoost": false,
      "accessSource": "direct"
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "nextCursor": "eyJuYW1lIjoiSm9obiIsImlkIjoiMTIzIn0=",
    "pageSize": 20,
    "totalRecords": 47
  }
}

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

​
pageSize
integer
default:20

Number of results per page (1-100).

Required range: 1 <= x <= 100
​
cursor
string

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

​
sortField
enum<string>
default:name

Field to sort results by.

Available options:
name,
email,
role
​
sortDirection
enum<string>
default:asc

Sort order.

Available options:
asc,
desc
​
accessSource
enum<string>

Filter by how access was granted:

  • direct — Only principals with explicit document permissions
  • folder — Only principals with inherited folder permissions
Available options:
direct,
folder
​
type
enum<string>

Filter by principal type:

  • user — Only individual users
  • userGroup — Only user groups
Available options:
user,
userGroup

Response

Successfully retrieved access list

​
principals
object[]
​
pageInfo
object

Pagination information for paginated responses.