Skip to navigation

GetFolderItems

View as Markdown

GetFolderItems requests all the envelopes in a specified folder for the requester or a Folder Owner.

Schema

// Create the folder filter to specify the scope of your search
// Here, we are limiting the item search to the inbox
// You can also limit by owner, date, status and position
DocuSignWeb.FolderFilter filter = new DocuSignWeb.FolderFilter();
filter.AccountId = _accountId;
filter.FolderTypeInfo = new DocuSignWeb.FolderTypeInfo();
filter.FolderTypeInfo.FolderType = DocuSignWeb.FolderType.Inbox;
// Now, call the method with the filter we created
DocuSignWeb.FolderResults results = _apiClient.GetFolderItems(filter);
// If there are results, print out the details
if (results.ResultSetSize > 0)
{
// Loop through and print out some information about the results
Console.WriteLine("Envelopes in the inbox are:");
foreach (DocuSignWeb.FolderItem item in results.FolderItems) {
Console.WriteLine("\tEnvelope {0} has status of: {1}",
item.EnvelopeId, item.Status);
}
}
NameSchema TypeDescription
AccountIdDSXIdThe account ID about which the call is requesting folder information.This is used in conjunction with the user passed in the API request.
FolderOwnerStringOptional field. The name of the user that currently owns the requested folders.
FolderTypeInfoFolderTypeInfoOptional FolderTypeInfo object. The type of folder and in some cases the name of the folder. Values can be RecycleBin, Draft, Inbox, SentItems or Normal. If no value is entered, the default search is Inbox.\n\n See FolderTypeInfo for more information.
StartPositionIntegerThe position of the folder items to return. This is used for repeated calls, when the number of envelopes returned is too much for one return (calls return 100 envelopes at a time). The default value is 0.
FromDatedateTimeOptional field. Only return items on or after this date. If no value is provided, the default search is the previous 30 days.
ToDatedateTimeOptional field. Only return items up to this date. If no value is provided, the default search is to the current date.
SearchTextStringOptional field. The search text used to search the items of the envelope. The search looks at recipient names and emails, envelope custom fields, sender name, and subject.
StatusStringOptional field. The current status of the envelope. If no value is provided, the default search is all/any status.

FolderResults

This is the response for a GetFolderItems request and provides the list of envelopes in the requested folder(s) for the requestor.

NameSchema TypeDescription
ResultSetSizeIntegerThe total number of envelopes in the folder for the dates requested.
StartPositionIntegerThe starting position of the folder items returned (only 100 results are returned at a time).
EndPositionIntegerThe end position of the folder items returned.
FolderItemsFolderItemProvides information about the envelopes in the specified folder. See FolderItem below.
FolderTypeInfoFolderTypeInfoThe type of folder and in some cases the name of the folder. Values can be RecycleBin, Draft, Inbox, SentItems or Normal.\n\nSee FolderTypeInfo for more information.

FolderItem

FolderItem provides the information about each envelope in a folder.

NameSchema TypeDescription
OwnerStringThe name of the user that currently owns the envelope.
EnvelopeIDLocalIdThe unique ID for the envelope.
StatusStringThe current status of the envelope.
SenderNameStringThe name of the sender of the envelope.
SenderEmailStringThe email for the sender of the envelope.
SenderCompanyStringThe company name of the sender of the envelope.
RecipientStatusesRecipientStatusA complex element that contains the status of each of the envelope recipients.
CustomFieldsCustomFieldA complex element that contains a list of names and values for any custom fields.
CreateddateTimeDate and time when the envelope was created.
SentdateTimeDate and time when the envelope was sent.
CompleteddateTimeDate and time when the envelope was completed.
SubjectStringThe envelope subject, as provided by the envelope creator.