Sign in
Users

Get Drives

List of accessible drive of a specific user

get/2/drive/users/{user_id}/drives

Path parameters

user_idinteger required

User identifier

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

account_idinteger required

Filter result by account identifier

The account identifier

rolesstring[] 
[
  "admin"
]
statusstring[]

Filter by status, if nothing provided active status is chosen

[
  "active"
]
pageinteger

Optional parameter that define the page number<br /> Part of the pagination capacity

per_pageinteger

Optional parameter that define the number of items per page<br /> Part of the pagination capacity

totalboolean

If set to true, return the total number of items. Total pages (<strong>pages</strong>) in response is also returned. <note>You can also use ?with=total parameter</note>

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

totalinteger

Total number of items Added when using query parameter page

pageinteger

Number of the current page Added when using query parameter page

pagesinteger

Total number of pages Added when using query parameter page

items_per_pageinteger

Number of items per page Added when using query parameter page

Example response

{
  "result": "success",
  "data": [
    {
      "type": "main",
      "drive_id": 1111,
      "drive": {
        "maintenance_reason": "demo_end",
        "account": {
          "name": "Secret Organization",
          "phone": "+41790000000",
          "website": "https://www.infomaniak.com"
        },
        "role": "admin",
        "rewind": {
          "status": "canceled",
          "mode": "directory",
          "archiving": "all",
          "directory": {
            "name": "Directory V3",
            "path": "/full/path/Directory V3",
            "type": "file",
            "status": "locked",
            "drive_id": 1111,
            "depth": 3,
            "shared_root_id": 1,
            "sharelink": {
              "url": "https://kdrive.infomaniak.com/app/share/xxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
              "right": "inherit"
            },
            "lock": {
              "description": "365",
              "token": "onlyoffice:123456"
            },
            "categories": [
              {
                "user_validation": "TO_VALIDATE",
                "category": {
                  "color": "#FF1493"
                }
              }
            ],
            "color": "#0098ff",
            "external_import": {
              "application": "dropbox",
              "status": "canceled"
            }
          }
        },
        "categories": [
          {
            "color": "#FF1493"
          }
        ],
        "tags": [
          {
            "id": 1234,
            "name": "My tag name",
            "color": 4,
            "product_count": 2
          }
        ],
        "capabilities": {
          "search": "content"
        },
        "settings": {
          "office": {
            "presentation": "365",
            "spreadsheet": "365",
            "text": "365",
            "default_mode": "desktop"
          },
          "report": {
            "storage_report": {
              "frequency": "monthly"
            }
          }
        },
        "pack": {
          "name": "team",
          "display_name": "Team"
        }
      },
      "status": "active",
      "role": "admin"
    }
  ],
  "total": 221,
  "page": 2,
  "pages": 15,
  "items_per_page": 15
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.