EnvelopeFolders
Get data associated to the folder an envelope exists in.
View Specific Information
The cmdlet will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the cmdlet.
- EnvelopeId supports the '='.
- FolderId supports the '='.
- Type supports the '='.
- DateToSearch supports the '=,>,>=,<,<='.
For example, the following queries are processed server side:
SELECT * FROM EnvelopeFolders WHERE EnvelopeId = '764c564c-b540-42d1-a667-ccee6813ef7b'; SELECT * FROM EnvelopeFolders WHERE FolderId = '7276150d-f5e0-4e5e-8c9f-cb80495c27ce'; SELECT * FROM EnvelopeFolders WHERE Type = 'draft'; SELECT * from EnvelopeFolders where DateToSearch = '2024-05-15 10:55:11'; SELECT * from EnvelopeFolders where DateToSearch < '2024-05-15 10:55:11'; SELECT * from EnvelopeFolders where DateToSearch <= '2024-05-15 10:55:11'; SELECT * from EnvelopeFolders where DateToSearch >= '2024-05-15 10:55:11'; SELECT * from EnvelopeFolders where DateToSearch > '2024-05-15 10:55:11'; SELECT * from EnvelopeFolders where DateToSearch > '2025-09-16T01:55:11-05:00' AND DateToSearch < '2025-09-16T01:55:11-05:00';
Columns
| Name | Type | References | Description |
| EnvelopeId [KEY] | String | The envelope's ID. | |
| FolderId [KEY] | String | The ID of the folder. | |
| Name | String | Name of the template. | |
| Type | String | The type of folder. | |
| Uri | String | The URI for the folder. | |
| ParentFolderId | String | The ID of the parent folder, or the special value root for the root folder. | |
| ParentFolderUri | String | The URI of the parent folder. | |
| SubFolderCount | Integer | The number of subfolders. | |
| HasAccess | Boolean | When true, the current user has access to the folder. | |
| HasSubFolders | Boolean | When true, the folder has subfolders. | |
| ItemCount | Integer | The number of items in the folder. | |
| OwnerAccountId | String | The account ID associated with the envelope. | |
| OwnerAccountName | String | The name on the account. | |
| OwnerActivationAccessCode | String | Access code provided to the user to activate the account. | |
| OwnerEmailId | String | The user's email address. | |
| OwnerIpAddress | String | The user's IP address. | |
| OwnerLoginStatus | String | When true, indicates that the user is logged in. This is a read-only property. | |
| OwnerMembershipId | String | The user's membership ID. | |
| OwnerUri | String | A URI containing the user ID. | |
| OwnerUserId | String | The ID of the user to access. | |
| OwnerUserName | String | The name of the user. | |
| OwnerUserStatus | String | Status of the user's account. | |
| OwnerUserType | String | The type of user, for example CompanyUser. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| DateToSearch | Datetime | Date to start fetching envelope identifiers from. |