v1
latestOpenAPI 3.0.12026-07-24241275527.9 KBGet Folders (Folder)
Returns the list of folders from a specific folder in the current account. If the root or recycle bin folder id is specified, the method returns the list of folders of the root and recycle bin respectively.<br> The method operates in two modes:
<ul> <li><b>Folder Tree Mode</b>: Activated if no filter parameters are provided. This mode returns the requested folders (spaces), their descendant folders, the root folder, and the recycle bin folder. <li><b>Folders Mode</b>: Activated if the parameter descendant=false is specified or if there is at least one filter parameter, e.g., project=true. This mode returns only the account's folders filtered by the specified parameters. </ul>The chosen mode can be identified by the "kind" key in the result JSON body, with "kind": "folderTree" for Folder Tree Mode and "kind": "folders" for Folders Mode.
<b>Scopes:</b> Default, wsReadOnly, wsReadWrite
Path parameters
Query parameters
Folder permalink, exact match
Folder permalink, exact match
Adds all descendant folders to search scope
Adds all descendant folders to search scope
Folders metadata filter
[Deprecated] It is recommended to use 'customFields' parameter. Custom field filter
Custom field filters, exact match. Limit : 25
Updated date filter, range
Include invitations in sharedIds list
Include invitations in sharedIds list
Filter only projects (true) / only folders (false)
Filter only projects (true) / only folders (false)
Contract type filter
- Billable - Billable
- NonBillable - Non-Billable
Strip HTML tags from custom fields
Strip HTML tags from custom fields
Custom item types filter. Standard types (project, folder) IDs are not allowed. Limit : 1000
The number of folders to return (max 1000 items per page). Only 'folders' kind is supported
The number of folders to return (max 1000 items per page). Only 'folders' kind is supported
A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call. Only 'folders' kind is supported
A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call. Only 'folders' kind is supported
Custom statuses filter
Authors filter, match of any
Assignees filter with specified users, match of any
Start date filter, date match or range
End date filter, date match or range
Completed date filter, date match or range
Title filter, contains match and accepts non-blank values only
Title filter, contains match and accepts non-blank values only
Json string array of optional fields to be included in the response model
- superParentIds - List of super parent folder IDs (applicable to 'Selective Sharing' labs feature)
- metadata - Folder metadata entries
- customItemTypeId - Work Item custom item type Id
- customFields - Custom fields
- customColumnIds - Associated custom field IDs
- contractType - Contract type
- description - Description
- attachmentCount - Attachment count
- hasAttachments - Has attachments
- briefDescription - Brief description
- space - Is folder a space
- finance - Project Finance fields
Response
success response