List all Root Directories

Returns a list of top-level Folder Objects that are read-accessible by the authenticated user.

Endpoint

 POST https://api.cloudplan.net/api/folder/root

Request Parameters

Possible request parameters

{
    "number": 0,
    "skip": 0,
    "admin": False
}

number | (optional) (integer)

Return this maximum amount of folder documents.

default: 50

skip | (optional) (integer)

Skip this many folder documents. Together with number this implements paging of the result.

default: 0

admin | (optional) (bool)

Run the request in admin-mode. If the calling user in a administrator for their organisation this will return all root folders where the organisation has permissions.

default: False

Reply Parameters

JSON Reply

{
    "roots": []
}

roots | (list)

A list of Folder Objects

Example

This request will list all top level folders where the user has read permissions.

Example request, an empty json because the parameters default values are sufficient.

{
}

Reply for the minimal example

{
    "result": true,
    "number": 1,
    "roots": [
        {
            "cp_id": "67BC32AC31D50D24C21FBA6DA4880A29",
            "children_cp_ids": [],
            "creation_timestamp": 1740386989,
            "individual_rights_user_56A23EB6998F303B134C1C0A723447B0": {
                "read_acl": true,
                "write_acl": true,
                "sync_acl": true,
                "delete_acl": true,
                "transfer_acl": true
            },
            "individual_rights_user_cp_ids": [
                "56A23EB6998F303B134C1C0A723447B0"
            ],
            "modify_timestamp": 1740386989,
            "name": "Invoice 2.0 Manual Test",
            "parent_folder_cp_id": "",
            "rights_user_56A23EB6998F303B134C1C0A723447B0": {
                "read_acl": true,
                "write_acl": true,
                "sync_acl": true,
                "delete_acl": true,
                "transfer_acl": true
            },
            "rights_user_cp_ids": [
                "56A23EB6998F303B134C1C0A723447B0"
            ],
            "sync_info_nodes_cp_ids": [
                "5C17C7695C97BF00166618E601086D9E"
            ],
            "sync_node_5C17C7695C97BF00166618E601086D9E": {
                "sync": true
            },
            "version": 1,
            "last_path_ids_rebuild_parent_id": "",
            "path_ids": [],
            "org_sync_info_56A23D908AD3312676D3D9DF9099A5C9": {
                "timestamp": 1740386990,
                "count_cloud": 1,
                "count_server": 0,
                "count_client": 0
            },
            "wf_autostart_config": {
                "template_id": "67BC3290CA63D36473C09D1C7F220C56",
                "min_event_age": 300,
                "use_manual_trigger": false
            },
            "upload_running": true,
            "has_sub_folder": false
        }
    ]
}