---
updatedAt: 2026-04-28T08:04:37.000Z
agentTools:
projectIndex: https://developers.wrike.com/llms.txt
---
# Get Rollup Settings (Folder)
Get rollup settings for folders. Use descendants=false (default) to query only the specified folders, or descendants=true to include descendant folders.
Scopes: Default, wsReadOnly, wsReadWrite
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "Wrike API",
"version": "4.0"
},
"servers": [
{
"url": "https://www.wrike.com/api/v4"
},
{
"url": "https://app-eu.wrike.com/api/v4"
},
{
"url": "https://app-us2.wrike.com/api/v4"
}
],
"paths": {
"/folders/{folderId}/rollups": {
"get": {
"tags": [
"Rollups"
],
"summary": "Get Rollup Settings (Folder)",
"description": "Get rollup settings for folders. Use descendants=false (default) to query only the specified folders, or descendants=true to include descendant folders.\n\nScopes: Default, wsReadOnly, wsReadWrite",
"operationId": "GET:/folders/single/rollups",
"parameters": [
{
"name": "folderId",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/FolderId"
}
},
{
"name": "descendants",
"in": "query",
"description": "Adds all descendant folders to search scope",
"required": false,
"schema": {
"type": "boolean",
"description": "Adds all descendant folders to search scope",
"default": "false"
}
},
{
"name": "filter",
"in": "query",
"description": "Filter rollup results by field configurations",
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RollupFilter"
}
}
}
},
{
"name": "pageSize",
"in": "query",
"description": "The number of rollup settings to return (max 100 items per page)",
"required": false,
"schema": {
"type": "number",
"description": "The number of rollup settings to return (max 100 items per page)"
}
},
{
"name": "nextPageToken",
"in": "query",
"description": "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.",
"required": false,
"schema": {
"type": "string",
"description": "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."
}
}
],
"responses": {
"2XX": {
"description": "success response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"kind": {
"$ref": "#/components/schemas/ResponseKind"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RollupSettings"
}
}
}
}
}
}
},
"4XX": {
"description": "client-side error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"5XX": {
"description": "server-side error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"HTTP": []
}
]
}
}
},
"components": {
"schemas": {
"ResponseKind": {
"type": "string",
"enum": [
"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"
]
},
"RollupSettings": {
"type": "object",
"properties": {
"itemId": {
"$ref": "#/components/schemas/TaskId"
},
"rollupSettings": {
"type": "array",
"description": "Rollup settings for fields",
"items": {
"$ref": "#/components/schemas/FieldRollupSettings"
}
},
"childIds": {
"type": "array",
"description": "Child item IDs",
"items": {
"$ref": "#/components/schemas/TaskId"
}
}
}
},
"ErrorType": {
"type": "string",
"enum": [
"invalid_request",
"invalid_parameter",
"parameter_required",
"not_authorized",
"access_forbidden",
"not_allowed",
"resource_not_found",
"method_not_found",
"too_many_requests",
"rate_limit_exceeded",
"server_error"
]
},
"RollupFilter": {
"required": [
"fields"
],
"type": "object",
"properties": {
"fields": {
"type": "array",
"description": "List of field filters",
"items": {
"$ref": "#/components/schemas/RollupFieldFilter"
}
}
}
},
"ErrorResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ErrorType"
},
"errorDescription": {
"type": "string"
}
}
},
"FolderId": {
"pattern": "^([a-zA-Z0-9-_:\\.=]){1,256}$",
"type": "string"
},
"TaskId": {
"pattern": "^([a-zA-Z0-9-_:\\.=]){1,256}$",
"type": "string"
},
"FieldRollupSettings": {
"required": [
"canToggle",
"fieldId",
"isEnabled",
"system"
],
"type": "object",
"properties": {
"system": {
"type": "boolean",
"description": "System field"
},
"isEnabled": {
"type": "boolean",
"description": "Rollup state for field"
},
"canToggle": {
"type": "boolean",
"description": "Whether the rollup can be toggled for field"
},
"fieldId": {
"type": "string",
"description": "Id of field: custom field or one of system fields: StartDate, DueDate, Effort, BookedEffort, PlannedFees, ActualFees, PlannedCost, ActualCost, TimeSpent\n"
}
}
},
"RollupFieldFilter": {
"required": [
"id"
],
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean",
"description": "Whether the field rollup should be enabled. If not provided, the field is included in results regardless of its enabled state"
},
"id": {
"type": "string",
"description": "Field id (system field name or custom field id)"
}
}
}
},
"securitySchemes": {
"HTTP": {
"type": "http",
"description": "Use OAuth 2.0 access token or permanent access token for authorization.",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
}
}
```