List Cabinet Users

Lists the active users who can access a company cabinet, with each user's current
upload/download notification setting for it. Use it to look up the UserIDs for
PUT /api/v2/files/containers/{containerID}/users/notifications.

userType — firm or client to return only that kind of user; omit to return both.

Display names are not unique; match on Email when resolving a specific person.

NotificationTypes is a bitmask: 256 = upload, 512 = download, 768 = both, 0 = off.

Supports paging (limit, offset), free-text search (matches name and email), and
sort (Name, Email) with optional desc=true. Default order is by name.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200

application/json

Success: Returns a page of users who can access the cabinet.

Body

Example

{
    "items": [
        {
            "userID": 0,
            "displayName": "string",
            "email": "string",
            "isClient": true,
            "hasNotifications": true,
            "notificationTypes": 0
        }
    ],
    "totalCount": 0,
    "limit": 0,
    "offset": 0
}

🟠400

🟠401

🟠403

Request

Responses