Skip to navigation

GetFolderList

View as Markdown

GetFolderList requests the list of all folders, including shared folders, available for the account.

Schema

GetFolderList
// Create the folders filter with an account ID
DocuSignWeb.FoldersFilter filter = new DocuSignWeb.FoldersFilter();
filter.AccountId = _accountId;
// Now, call the method to get a list of the folders on the
// specified account
DocuSignWeb.AvailableFolders folders = _apiClient.GetFolderList(filter);
// Everyone will at least have the folders:
// Draft, Sent Items, Inbox and Deleted Items
// Print out some information about the returned folders
Console.WriteLine("The folders available on account {0} are:", _accountId);
foreach (DocuSignWeb.Folder folder in folders.Folders)
{
Console.WriteLine("\t{0} owns folder {1}", folder.FolderOwner.UserName, folder.FolderTypeInfo.FolderName);
}
NameSchema TypeDescription
AccountIdDSXIdThe account ID associated with the requested folder.
IncludeHierarchyBooleanIf true, the folder’s hierarchical positions are returned.

AvailableFolders

This is the response to a GetFolderList request and provides the list of folders, including shared folders, for the requestor.

NameSchema TypeDescription
FoldersFoldersAn array of Folder objects with the FolderOwner and FolderTypeInfo.

Folder

Provides the Folder Owner and Folder Type information.

NameSchema TypeDescription
FolderOwnerStringThe name of the user that currently owns the folder.
FolderTypeInfoFolderTypeInfoThe type of folder and in some cases the name of the folder. Values can be RecycleBin, Draft, Inbox, SentItems or Normal.

FolderTypeInfo

Provides the Folder Type information and, if the Folder Type is Normal, the Folder Name.

NameSchema TypeDescription
FolderTypeFolderTypeThe type of folder based on the GetFolders call. Values can be RecycleBin, Draft, Inbox, SentItems or Normal.
FolderNameStringThe name of the folder. This only appears if the FolderType is Normal.
FolderPathStringthe hierarchical path to the folder, comprised of bar delimited FolderIds
FolderIdStringThe folder’s (Guid) identifier.