---
schema_version: "1"
id: 3002adf2712744fdba73fc4628a2205a7c2a13e033fab263fda6a08ad144b40e
title: Folder Operations
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/analytics/api_analytics/guides/reference/folders/analytics-api-folders-ops.md
canonical_url: https://developer.salesforce.com/docs/analytics/salesforce-analytics-rest-api/guide/analytics-api-folders-ops.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: ec12b446e1f77129c702b846d29179edc488258710dbfa0c14023a1ca8c77e5a
products:
  - Salesforce Reports and Dashboards REST API Developer Guide
  - analytics
---

# Folder Operations

Enables renaming, deleting, and obtaining information on report and dashboard folders.

The following user permissions are needed to access this resource.

GET:

-   View access for the folder

PATCH/DELETE:

-   Manage access for the folder

## Syntax

**URI:** `/services/data/v43.0/folders/<folderid>`

**Formats:** JSON

**HTTP methods**

|Method|Description|
|------|-----------|
|`GET`|Gets information about the folder that has the specified folder ID.|
|`PATCH`|Updates the label or name of the folder with the specified folder ID.<ul><li>All users with manage access on the folder can change the folder label.</li><li>Only admin users can change the folder name.</li></ul>|
|`DELETE`|Deletes the folder that has the specified folder ID.|

**Parameters**

|Parameter|Description|
|---------|-----------|
|`folderId`|Specifies a unique folder ID.|

## GET

Gets information about the folder that has the specified folder ID.

`/services/data/v43.0/folders/<folderid>`

**Output Payload**

[FolderDetailRepresentatiion](#folder-operations)

**FolderDetailRepresentatiion**

|Field|Type|Available Version|Description|
|-----|----|-----------------|-----------|
|`id`|String|42.0|Unique folder identifier.|
|`label`|String|42.0|Folder display name.|
|`name`|String|42.0|Folder unique name.|
|`namespace`|String|42.0|Namespace prefix to differentiate custom object and field names from those in use by other organizations.|
|`type`|[ConnectFolderTypeEnum](#folder-operations)|42.0|Defined by the type of entity the folder contains.|
|`parentId`|ID|43.0|ID of the parent folder.|
|`url`|ConnectUri|43.0|URL of the folder:  `/services/data/v43.0/folders/<folderid>`|
|`childrenUrl`|ConnectUri|43.0|URL that represents the first level subfolders of the specified folder: `/services/data/v43.0/folders/<folderid>/children`|
|`depth`|Integer|43.0|Depth of the folder in the tree. A folder with depth 0 is the root folder.|
|`supportedShareTypes`s|List \<[supportedShareTypes](https://developer.salesforce.com/docs/analytics/salesforce-analytics-rest-api/guide/analytics-api-folders-share-recipients.md)>|43.0|List of supported share types for the folder in the organization.|
|`sharesUrl`|ConnectUri|43.0|URL of the shares for the particular folder: `/services/data/v43.0/folders/<folderid>/shares`|
|`shareRecipientsUrl`|ConnectUri|43.0|URL of the recipients of the share: `/services/data/v43.0/folders/<folderid>/share-recipients`|
|`ancestors`|List \<[FolderSummaryRepresentation](#folder-operations)>|43.0|This folder’s ancestor folders, ordered by depth.|

**ConnectFolderTypeEnum**

|Type|Description|
|----|-----------|
|Dashboard|Dashboard folders.|
|Document|Document folders.|
|Email|Email folders.|
|Insights|Insights folders.|
|Reports|Reports folders.|

**FolderSummaryRepresentation**

|Field|Type|Available Version|Description|
|-----|----|-----------------|-----------|
|`id`|ID|43.0|Unique identifier.|
|`label`|String|43.0|Display label.|
|`name`|String|43.0|Folder unique name.|
|`namespace`|String|43.0|Namespace prefix to differentiate custom object and field names from those in use by other organizations.|
|`type`|[ConnectFolderTypeEnum](#folder-operations)|43.0|Defined by the type of entity the folder contains.|
|`parentId`|ID|43.0|ID of the parent folder.|
|`url`|ConnectUri|43.0|URL of the folder:  `/services/data/v43.0/folders/<folderid>`|
|`childrenUrl`|ConnectUri|43.0|URL that represents the first level subfolders of the specified folder: `/services/data/v43.0/folders/<folderid>/children`|
|`depth`|Int|43.0|Depth of the folder in the tree. A folder with depth 0 is the root folder.|

**Sample Output Response**

```nolang
{
  "ancestors" : [ ],
  "childrenUrl" : "/services/data/v43.0/folders/00lxx000000flSFAAY/children",
  "depth" : 0,
  "id" : "00lxx000000flSFAAY",
  "label" : "report_folder",
  "name" : "report_folder1",
  "shareRecipientsUrl" : "/services/data/v43.0/folders/00lxx000000flSFAAY/share-recipients?shareType=User&limit=100",
  "sharesUrl" : "/services/data/v43.0/folders/00lxx000000flSFAAY/shares",
  "supportedShareTypes" : [ "user", "role", "roleandsubordinates", 	"roleandsubordinatesinternal", "group", "portalrole", "portalroleandsubordinates", 	"customerportaluser" ],
  "type" : "report",
  "url" : "/services/data/v43.0/folders/00lxx000000flSFAAY"
}
```

## PATCH

Updates the label or name of the folder with the specified folder ID.

-   Users with manage access on the folder can change the folder label.
-   Only admin users can change the folder name.

`/services/data/v43.0/folders/<folderid>`

**Request Body**

|Query Parameter Name|Group|Since|Available Version|Description|
|--------------------|-----|-----|-----------------|-----------|
|`folder`|Object|42.0|[FolderInputRepresentation](#folder-operations)|Users with edit access on the folder can change `label` . Admins can change `name` . `type` cannot be changed.|

**FolderInputRepresentation**

|Code|Type|Available Version|Description|
|----|----|-----------------|-----------|
|`label`|String|42.0|Folder display name.|
|`name`|String|42.0|Folder unique name. This is a mandatory field for admins; for non-admins, it is auto-generated.|
|`type`|[ConnectFolderTypeEnum](#folder-operations)|42.0|Defined by the type of entity the folder contains:|
|`parentId`|String|43.0|ID of the parent folder. This field is valid only for subfolders.|

**Sample Request Body**

```nolang
{
  "label": "report_folder1",
  "name": "report_folder1"
}

```

**Sample Raw Response**

```nolang
{
  "ancestors" : [ ],
  "childrenUrl" : "/services/data/v43.0/folders/00lxx000000flSFAAY/children",
  "depth" : 0,
  "id" : "00lxx000000flSFAAY",
  "label" : "report_folder1",
  "name" : "report_folder1",
  "shareRecipientsUrl" : "/services/data/v43.0/folders/00lxx000000flSFAAY/share-recipients?shareType=User&limit=100",
  "sharesUrl" : "/services/data/v43.0/folders/00lxx000000flSFAAY/shares",
  "supportedShareTypes" : [ "user", "role", "roleandsubordinates", 	"roleandsubordinatesinternal", "group", "portalrole", "portalroleandsubordinates", 	"customerportaluser" ],
  "type" : "report",
  "url" : "/services/data/v43.0/folders/00lxx000000flSFAAY"
}
```

## DELETE

Deletes the folder that has the specified folder ID.

`/services/data/v43.0/folders/<folderid>`