WRwrike
Folders & Projects

Get Folders (Folder)

Changed on

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

get/folders/{folderId}/folders

Request

  • Base URL
    https://www.wrike.com/api/v4
  • URL
    https://www.wrike.com/api/v4/folders/{folderId}/folders
  • Auth
    HTTP bearer

Path parameters

folderIdstring required

Query parameters

permalinkstring

Folder permalink, exact match

descendantsboolean

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

withInvitationsboolean

Include invitations in sharedIds list

projectboolean

Filter only projects (true) / only folders (false)

Contract type filter

  • Billable - Billable
  • NonBillable - Non-Billable
plainTextCustomFieldsboolean

Strip HTML tags from custom fields

Custom item types filter. Standard types (project, folder) IDs are not allowed. Limit : 1000

pageSizenumber

The number of folders to return (max 1000 items per page). Only 'folders' kind is supported

nextPageTokenstring

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

titlestring

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

kind'accounts' | 'users' | 'contacts' | 'assets' | 'eDiscoveryReport' | 'folders' | 'folderTree' | 'tasks' | 'taskIds' | 'timelogs' | 'timelogCategories' | 'timelogLockPeriods' | 'timetrackerTimers' | 'comments' | 'attachments' | 'url' | 'version' | 'dataExport' | 'dataExportSchema' | 'auditLog' | 'accessRoles' | 'stream' | 'changes' | 'posts' | 'mailSettings' | 'integrationInfo' | 'gmailIntegrationSettings' | 'workTypesForIntegrations' | 'ids' | 'backups' | 'domains' | 'dependencies' | 'workflows' | 'workschedules' | 'workscheduleExclusions' | 'workscheduleUserExclusions' | 'customfields' | 'customfieldIds' | 'customstatuses' | 'invitations' | 'notifications' | 'jobroles' | 'placeholders' | 'groups' | 'session' | 'dashboards' | 'widgets' | 'taskCreationSettings' | 'colors' | 'experiments' | 'topics' | 'topicComments' | 'webhooks' | 'reviews' | 'boards' | 'textSearch' | 'chatChannels' | 'chatMessages' | 'forms' | 'requestForms' | 'request' | 'report' | 'platformWidgets' | 'platformWidgetInstances' | 'spaces' | 'pdf' | 'customerSatisfaction' | 'asyncJob' | 'approvals' | 'highlights' | 'highlightsList' | 'highlightsSettings' | 'highlightsCard' | 'timesheet' | 'timesheetRow' | 'timesheetSubmissionRule' | 'mobileFeatures' | 'mobileSettings' | 'folderBlueprintTree' | 'taskBlueprintTree' | 'blueprintSearch' | 'feedback' | 'timeline_snapshot' | 'contactIds' | 'bookings' | 'integrateThreshold' | 'hourlyRatesProvision' | 'hourlyRates' | 'projectTeamMembers' | 'contactsHistory' | 'tasksHistory' | 'foldersHistory' | 'activityDigest' | 'workItemTemplates' | 'workTemplates' | 'workItemMetadata' | 'workItem' | 'customItemTypes' | 'verificationCode' | 'views' | 'listView' | 'tableView' | 'userTypes' | 'reactions' | 'externalRequesters' | 'workscheduleCapacityOverrides' | 'userCapacityOverrides' | 'userCapacityExclusions' | 'rollups' | 'requestFormPrefill' | 'mcpFeatures' | 'attachmentUploadUrl' | 'userAggregatedCapacity' | 'cascadingFieldSettings' | 'recommendResources' | 'aggregatedAllocatedEffort' | 'aggregatedTotalUserEffort' | 'aggregatedTimeSpent' | 'folderBlueprint' | 'taskBlueprint'

Changes

  • 7b0a63c547ddRevision changes
    • breaking

      the response property // became optional for the status

    • breaking

      removed the required property // from the response with the status

    • warning

      added the new aggregatedAllocatedEffort enum value to the response property for the response status

    • warning

      added the new aggregatedTimeSpent enum value to the response property for the response status

    • warning

      added the new aggregatedTotalUserEffort enum value to the response property for the response status

    • warning

      added the new attachmentUploadUrl enum value to the response property for the response status

    • warning

      added the new blueprintSearch enum value to the response property for the response status

    • warning

      added the new folderBlueprint enum value to the response property for the response status

    • warning

      added the new mcpFeatures enum value to the response property for the response status

    • warning

      added the new recommendResources enum value to the response property for the response status

    • warning

      added the new taskBlueprint enum value to the response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status