Folders resource
Developing with the CLM API is only available for CLM customers with a production account. To purchase a plan to gain access to the CLM API, contact Docusign Sales.
Methods supported
| Method | Description |
|---|---|
| Delete | DEL /v2/{accountId}/folders/{id}Move a folder to the trash folder |
| Get | GET /v2/{accountId}/folders/{id}Get a folder by ID |
| GetByEos | GET /v2/{accountId}/folders/eosGet a folder by eosObjectType and eosObjectId |
| GetByPath | GET /v2/{accountId}/folders/pathGet a folder by path |
| GetBySystemType | GET /v2/{accountId}/folders/typeGet a folder by path or system folder type |
| GetChildFolders | GET /v2/{accountId}/folders/{id}/foldersGet the folders in a folder |
| GetDocuments | GET /v2/{accountId}/folders/{id}/documentsGet the documents in a folder |
| GetShareLinks | GET /v2/{accountId}/folders/{id}/sharelinksGet the share links of a folder |
| Patch | PATCH /v2/{accountId}/folders/{id}Update a folder |
| Post | POST /v2/{accountId}/foldersCreate a folder |
| Put | PUT /v2/{accountId}/folders/{id}Update a folder |
| Search | POST /v2/{accountId}/folders/searchSearch for folders |
Folders properties
| Property | Type | Description |
|---|---|---|
AccessLevel | AccessLevel | Permissions on the folder for the current user |
AttributeGroups | object | Attribute groups saved on the folder |
BrowseDocumentsUrl | string | Uri where the contents of this folder can be viewed in a browser |
CreatedBy | string | Username of user that created the folder. Sortable |
CreatedDate | string (date-time) | Date and time folder was created. Sortable |
CreateDocumentHref | string | Uri for uploading a document into the folder |
Description | string | Description of the folder. Filterable and sortable |
Documents | ApiCollection_Document_ | Documents contained within the folder |
EosInfo | EosInfo | External object storage information for the folder. Used when creating a new EOS folder. Exclude Name and ParentFolder when creating a folder with EOSInfo |
EosParentInfo | EosInfo | External object storage information for the next EOS object up the tree from this folder. If the folder is contained directly within an EOS object, this is the EOS info for the parent folder |
Folders | ApiCollection_Folder_ | Folders contained within the folder (i.e. subfolders) |
Href | string | Uri where the object can be retrieved. |
Name | string | Name of the folder. This property is required to create a non-EOS folder along with ParentFolder. Filterable and sortable |
ParentFolder | Folder | Folder that contains this folder. Required along with Name when creating a non-EOS folder |
Path | string | The file path of the folder within the account’s folder structure |
PropagateAttributeGroupsToChildren | boolean | Propagate Attribute groups on the folder to it’s children |
Security | Securities | Security rules currently defined for the folder |
ShareLinks | ApiCollection_ShareLink_ | Share links that have been created for the folder |
UpdatedBy | string | Username of user that last updated the folder. Sortable |
UpdatedDate | string (date-time) | Date and time folder was last updated. Sortable |