GET api/Folders/{folderId}/Subfolders?folderName={folderName}&pageSize={pageSize}&page={page}&sortBy={sortBy}&sortDirection={sortDirection}
Gets the folder's subfolders.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| folderId |
The folder identifier. |
integer |
Required |
| folderName |
The folder name (if any) to filter by. |
string |
Required |
| pageSize |
The number of results to return. |
integer |
None. |
| page |
The results page to return. |
integer |
None. |
| sortBy |
The field to sort by. |
string |
None. |
| sortDirection |
The direction to sort by. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
The folders model.
ESignSystems.SmartSAFE.Models.Folders.FoldersModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Folders |
Gets or sets the list of folders. |
Collection of ESignSystems.SmartSAFE.Models.Folders.FolderModel |
None. |
| TotalResultsCount |
Gets or sets the number of folders. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Folders": [
{
"FolderId": 1,
"ParentFolderId": 1,
"ClientId": 1,
"Name": "sample string 1",
"CreatedDate": "2025-11-02T09:47:44.6364053-05:00"
},
{
"FolderId": 1,
"ParentFolderId": 1,
"ClientId": 1,
"Name": "sample string 1",
"CreatedDate": "2025-11-02T09:47:44.6364053-05:00"
}
],
"TotalResultsCount": 1
}
application/xml, text/xml
Sample:
<FoldersModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Folders">
<Folders>
<FolderModel>
<ClientId>1</ClientId>
<CreatedDate>2025-11-02T09:47:44.6364053-05:00</CreatedDate>
<FolderId>1</FolderId>
<Name>sample string 1</Name>
<ParentFolderId>1</ParentFolderId>
</FolderModel>
<FolderModel>
<ClientId>1</ClientId>
<CreatedDate>2025-11-02T09:47:44.6364053-05:00</CreatedDate>
<FolderId>1</FolderId>
<Name>sample string 1</Name>
<ParentFolderId>1</ParentFolderId>
</FolderModel>
</Folders>
<TotalResultsCount>1</TotalResultsCount>
</FoldersModel>