Folders

Use the Analytics Folders API to perform operations on report and dashboard folders. The Folders API is available in API version 41.0 and later.

Resources for the Analytics Folders API are available at /services/data/<latest API version>/folders. You can query each resource with an HTTP method.

<sfdocstbl><table>

<col> </col> <col> </col> <col> </col> <thead> <tr> <th> Resource </th> <th> Supported HTTP Method </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <p> <a href="analytics-api-folders-create.md#folder-collections" title="Enables creation of report and dashboard folders and obtaining the list of folders.">Folder Collections</a> </p> <p> <code>/services/data/&lt;span&gt;&lt;latest API version&gt;&lt;/span&gt;/folders/</code> </p> </td> <td> <p> <code>POST</code> </p> <p> <code>GET</code> </p> </td> <td> Enables creation of report and dashboard folders and subfolders ( <code>POST</code> ). <p> Gets the list of folders ( <code>GET</code> ). </p> </td> </tr> <tr> <td> <a href="analytics-api-folders-ops.md#folder-operations" title="Enables renaming, deleting, and obtaining information on report and dashboard folders.">Folder Operations</a> <p> <code>/services/data/&lt;span&gt;&lt;latest API version&gt;&lt;/span&gt;/folders/&lt;span&gt;&lt;folderid&gt;&lt;/span&gt;</code> </p> </td> <td> <p> <code>GET</code> </p> <p> <code>PATCH</code> </p> <p> <code>DELETE</code> </p> </td> <td> Enables renaming ( <code>PATCH</code> ), deleting ( <code>DELETE</code> ), and obtaining information ( <code>GET</code> ) on the report or dashboard folder or subfolder. </td> </tr> <tr> <td> <a href="analytics-api-folders-shares.md#folder-shares" title="Extracts a list of current folder shares (GET), adds new shares (POST), or replaces existing shares (PUT).">Folder Shares</a> <p> <code>/services/data/&lt;span&gt;&lt;latest API version&gt;&lt;/span&gt;/folders/&lt;span&gt;&lt;folderid&gt;&lt;/span&gt;/shares</code> </p> </td> <td> <p> <code>GET</code> </p> <p> <code>PUT</code> </p> <p> <code>POST</code> </p> </td> <td> <p> Extracts a list of current folder shares ( <code>GET</code> ), adds new shares ( <code>POST</code> ), or replaces existing shares ( <code>PUT</code> ). </p> </td> </tr> <tr> <td> <a href="analytics-api-folders-shares-by-id.md#folder-share-by-id" title="For a specified share ID, extracts folder share information (GET), updates the access level on the share (PATCH), or deletes the share (DELETE).">Folder Share by ID</a> <p> <code>/services/data/&lt;span&gt;&lt;latest API version&gt;&lt;/span&gt;/folders/&lt;span&gt;&lt;folderid&gt;&lt;/span&gt;/shares/</code> <span><shareid></span> </p> </td> <td> <p> <code>GET</code> </p> <p> <code>PATCH</code> </p> <p> <code>DELETE</code> </p> </td> <td> <p> For a specified share ID, extracts the share information ( <code>GET</code> ), updates the access level on the share ( <code>PATCH</code> ), or deletes the share ( <code>DELETE</code> ). </p> </td> </tr> <tr> <td> <a href="analytics-api-folders-share-recipients.md#folder-share-recipients" title="Return a list of folder share recipients.">Folder Share Recipients</a> <p> <code>/services/data/&lt;span&gt;&lt;latest API version&gt;&lt;/span&gt;/folders/&lt;span&gt;&lt;folderid&gt;/&lt;/span&gt;share-recipients?shareType=&lt;span&gt;&lt;shareType&gt;&lt;/span&gt;</code> </p> </td> <td> <p> <code>GET</code> </p> </td> <td> <p> Returns a list of folder share recipients ( <code>GET</code> ). </p> </td> </tr> <tr> <td> <a href="analytics-api-folders-children.md#folder-child-operations" title="Gets information about the child folders of the specified folder.">Folder Child Operations</a> <p> <code>/services/data/&lt;span&gt;&lt;latest API version&gt;&lt;/span&gt;/folders/&lt;span&gt;&lt;folderid&gt;&lt;/span&gt;/children/</code> </p> </td> <td> <p> <code>GET</code> </p> </td> <td> <p> Returns a list of first-level child folders (subfolders) ( <code>GET</code> ). </p> </td> </tr> </tbody> </table></sfdocstbl>