Rollups

Get Rollup Settings (Folder)

Changed on

Get rollup settings for folders. Use descendants=false (default) to query only the specified folders, or descendants=true to include descendant folders.

<b>Scopes:</b> Default, wsReadOnly, wsReadWrite

get/folders/{folderId}/rollups

Request

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

Path parameters

folderIdstring required

Query parameters

descendantsboolean

Adds all descendant folders to search scope

Filter rollup results by field configurations

pageSizenumber

The number of rollup settings to return (max 100 items per page)

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.

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

    • 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