Tips and FAQ

What ID Can Be Used To Get The Root Folder of Documents Hub Elements?

We are in the process of normalizing the documents hub even further, but there are always a few unique API provider differences and the 'ID' used to make a GET by the root folder ID is one such difference.

Currently the following values can be used in these elements to make GET calls directly against the root folder by ID (for example, GET /folders/{id}/contents or GET /folders/{id}/metadata).

  • Box: 0. For example GET /folders/0/contents.
  • Dropbox: Double URL-encoded path: %252F. For example, GET /folders/%252F/contents.
  • Google Drive: root.  For example, GET /folders/root/contents.
  • OneDrive: root. For example, GET /folders/root/contents.
  • ShareFile: Whatever value was input at instance provision as the Sharefile root folder, such as top. For example, GET /folders/top/contents.

What's the difference between the /root and /top folders?

Some folders have shortcuts, which serve as folder names as well as IDs. The /top folder is the root level folder. This should be used in the path similarly to how a root level folder / would be used. The other three, favorites, home, and allshared will be shortcuts to your favorites, home, and shared root level folders