Skip to main content

When you need Folder ID for setting the Parent ID to set the location of the file when creating or copy a document with https://developer.lucid.co/reference/createorcopyorimportdocument.

https://api.lucid.co/documents

The parent must be an integer as said in the doc.

But if you want to use:

   “My documents”,

   “Team folders”,

   “Shared with me”

the folder ID are respectively (extracted from the url):

   folder_id=home

   folder_id=project

  folder_id=shared

This appears to be very strange to me and moreover we cannot use these values as parameters when using this API.

Any help will be appreciated.

Best regards.

Hello Michel,

I can see the confusion. Internally, we call these “virtual folders” and they are essentially aliases so that links and bookmarks will always take the user to the correct place, regardless of their actual function. Some of them are not folders at all, but are categories in our document lists for the user. I believe only one could make sense to extend to the public API for convenience/clarity, but most wouldn’t. Here is the breakdown of virtual folders I am aware of. (Some may be missing as they tend to evolve quickly):

  • home
    • A zero state list of the user’s documents. Created documents without a parent will be shown here, in addition to other documents of interest to the user.
      • Essentially, this is where it ends up when no parent is provided. Sometimes called “root” and corresponds to “My Documents” in the Lucid document list
      • This could be added as a parameter, and I think “root” is
  • project
    • A virtual parent of all the team folders that user has access to. Primaryily used to display a list of the user’s team folders
      • Could not be a valid parameter as it is not a folder itself
  • shared
    • Folders that have been shared to the user. Similar to “project”, but spans all folder types, not just “Team Folders”
      • Adding a user as a collaborator on a folder would cause that folder to appear here
      • Could not be a valid parameter as it’s not a folder itself
  • trash
    • Folders that have been deleted but not yet passed the expiration to be permanently purged.
      • Could not be a valid parameter as it’s not a folder itself
  • suggested
    • Documents that Lucid believes the user is most likely to be looking for
      • Could not be a valid parameter as it’s not a folder itself
  • recent
    • Documents which were most recently interacted with by the user
      • Could not be a valid parameter as it's not a folder itself

 


Reply