List Containers

GET

/api/v2/files/containers

Last modified:2026-09-02 03:28:41

x-required-permission:[{"type":"FileContainers","permission":"View"},{"type":"Files","permission":"View"}]

Retrieves a page of file containers accessible to the current user.
Each container includes its name, owner, access type, and folder count.

Supports paging (limit, offset), free-text search (matches container and owner
names), and sort (Name, Owner) with optional desc=true. Omitting sort keeps
the default order.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Responses

🟢200

application/json

Success: Returns a page of accessible file containers.

Body

Example

{
    "items": [
        {
            "containerID": 0,
            "containerName": "string",
            "code": "string",
            "accessType": 0,
            "ownerID": null,
            "ownerName": "string",
            "companyID": null,
            "active": true,
            "folderCount": 0,
            "created": "2019-08-24T14:15:22.123Z",
            "modified": null,
            "hasNotifications": true,
            "notificationTypes": 0
        }
    ],
    "totalCount": 0,
    "limit": 0,
    "offset": 0
}

🟠400

🟠403

Modified at 2026-09-02 03:28:41

Download 'All Engagements' Report

Create Company Cabinet