Folder
A folder: a named container of documents and subfolders, in a deal's folder tree or a user's.
idrequiredstring (uuid)- The folder's id.
namerequiredstring- The folder's name, unique among its live siblings.
parent_idrequiredstring | null (uuid)- The folder this one sits in. Null for a root folder, which belongs to a deal or a user.
pathrequiredstring- The names of the folders from the root down to this one, joined by " / ".
deal_idrequiredstring | null (uuid)- The deal whose folder tree holds this folder, or null when it is not in a deal's tree.
namespacerequiredstring | null- What the platform uses the folder for.One of: attachment.sig.root, attachment.sig.entity, attachment.user.custom, attachment.sig.entity.counter, attachment.sig.entity.counter.internal, attachment.user.other, attachment.user.other.default, deal.core.assets, deal.core.deal_information, deal.core.root, deal.core.text_editor_uploads, deal.tm.committed, deal.tm.confirmed, deal.tm.custom, deal.tm.preinvestment, portfolio.root, portfolio.user.documents, portfolio.asset.public, team.core.root, team.core.termsandconditions
type_idrequiredstring | null (uuid)- The folder's type. Null when it has none. Use GET /folder-types to look the types up.
lockedrequiredboolean- A locked folder cannot be renamed, moved, or have folders added to it until it is unlocked.
pinnedrequiredboolean- Pinned folders are shown first in the platform.
releasedrequiredboolean- Whether the folder's documents are released to the people it is shared with.
accessrequiredobject- Groups of users who may read and write the folder without being listed in its permissions.
metadatarequiredobject | null- Free-form key-value data kept with the folder.
permissionsobject- Who may read and write the folder, including what it inherits from the folders above it.
created_atrequiredstring (date-time)- When the folder was created.
updated_atrequiredstring (date-time)- When the folder last changed.