---
schema_version: "1"
id: 86920205946e55d1f626dd2e827cc40ca1251422723e992c46190ce3669e28ce
title: Folders List Resource
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/bi_dev_guide_rest/bi_resources_folders.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 43ae3c15f5c624c695e3433ca4c8d75d03a0339a37c973e9d9092d8945719e6d
description: Returns a collection of apps or folders and creates an Analytics app, which is a folder that contains Analytics dataset, lenses, and dashboard.
---
# Folders List Resource

Returns a collection of apps or folders and creates an Analytics app, which is a folder that contains Analytics dataset, lenses, and dashboard.

## Resource URL

/wave/folders

## Formats

JSON

## Available Version

36.0

## Available in Postman

To view and test a working example of this resource, see [getWaveFolderCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-1ef07cc4-fcb6-47f4-9bee-0262bfe41533?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response.").

## Available Components

- Aura — [<wave:sdk> createFolder()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_template.htm)
- Aura — [<wave:sdk> listFolders()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_template.htm)
- LWC — [lightning/analyticsWaveApi getWaveFolders()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-wave-folders.html)
- LWC — [lightning/analyticsWaveApi postWaveFolders()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-post-wave-folders.html)

## HTTP Methods

GET POST

## Request parameters for GET

<table class="featureTable sort_table" summary="">





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d287284e154">Parameter Name</th>

              <th class="featureTableHeader vertical-align-top " id="d287284e157">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d287284e160">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d287284e163">Required or Optional</th>

              <th class="featureTableHeader vertical-align-top " id="d287284e166">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d287284e154" data-title="Parameter Name"><samp class="codeph nolang">is​Pinned</samp></td>

              <td class="entry" headers="d287284e157" data-title="Type">Boolean</td>

              <td class="entry" headers="d287284e160" data-title="Description">Indicates whether to filter the collection of folders to return only
                pinned folders (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d287284e163" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d287284e166" data-title="Available Version">36.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d287284e154" data-title="Parameter Name"><samp class="codeph nolang">﻿mobile​Only​Featured​Assets</samp></td>

              <td class="entry" headers="d287284e157" data-title="Type">Boolean</td>

              <td class="entry" headers="d287284e160" data-title="Description">Indicates whether to filter the collection of folders to show only
                dashboards that are enabled for the Analytics mobile app (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d287284e163" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d287284e166" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d287284e154" data-title="Parameter Name"><samp class="codeph nolang">page</samp></td>

              <td class="entry" headers="d287284e157" data-title="Type">String</td>

              <td class="entry" headers="d287284e160" data-title="Description">A generated token that indicates the view of folders to be
                returned.</td>

              <td class="entry" headers="d287284e163" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d287284e166" data-title="Available Version">36.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d287284e154" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

              <td class="entry" headers="d287284e157" data-title="Type">Integer</td>

              <td class="entry" headers="d287284e160" data-title="Description">The number of items to be returned in a single page. Minimum is 1,
                maximum is 200, and default is 25.</td>

              <td class="entry" headers="d287284e163" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d287284e166" data-title="Available Version">36.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d287284e154" data-title="Parameter Name"><samp class="codeph nolang">q</samp></td>

              <td class="entry" headers="d287284e157" data-title="Type">String</td>

              <td class="entry" headers="d287284e160" data-title="Description">Search terms. Individual terms are separated by spaces. A wildcard is
                automatically appended to the last token in the query string. If the user’s
                search query contains quotation marks or wildcards, those symbols are
                automatically removed from the query string in the URI along with any other
                special characters.</td>

              <td class="entry" headers="d287284e163" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d287284e166" data-title="Available Version">36.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d287284e154" data-title="Parameter Name"><samp class="codeph nolang">scope</samp></td>

              <td class="entry" headers="d287284e157" data-title="Type">Connect​Wave​Scope​Type​Enum</td>

              <td class="entry" headers="d287284e160" data-title="Description">The type of scope to be applied to the returned collection. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Browse</samp></li>

                  <li class="li"><samp class="codeph nolang">Created​By​Me</samp></li>



                  <li class="li"><samp class="codeph nolang">Insights​Applications​Is​Cans​Edit</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Mru</samp> (Most Recently Used)
                  </li>

                  <li class="li"><samp class="codeph nolang">Shared​With​Me</samp></li>

                </ul>
              </td>

              <td class="entry" headers="d287284e163" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d287284e166" data-title="Available Version">38.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d287284e154" data-title="Parameter Name"><samp class="codeph nolang">sort</samp></td>

              <td class="entry" headers="d287284e157" data-title="Type">Connect​Wave​Sort​Order​Type​Enum</td>

              <td class="entry" headers="d287284e160" data-title="Description">The type of sort order to be applied to the returned collection. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">App</samp></li>

                  <li class="li"><samp class="codeph nolang">Created​By</samp></li>

                  <li class="li"><samp class="codeph nolang">Created​By​Id</samp></li>

                  <li class="li"><samp class="codeph nolang">Created​Date</samp></li>

                  <li class="li"><samp class="codeph nolang">Folder​Name</samp></li>

                  <li class="li"><samp class="codeph nolang">Last​Modified</samp></li>

                  <li class="li"><samp class="codeph nolang">Last​Modified​By</samp></li>

                  <li class="li"><samp class="codeph nolang">Last​Modified​By​Id</samp></li>

                  <li class="li"><samp class="codeph nolang">Last​Modified​Date</samp></li>

                  <li class="li"><samp class="codeph nolang">Location</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Mru</samp> (Most Recently Used, last viewed date)
                  </li>

                  <li class="li"><samp class="codeph nolang">Name</samp></li>

                  <li class="li"><samp class="codeph nolang">Outcome</samp></li>

                  <li class="li"><samp class="codeph nolang">Owner</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">Refresh​Date</samp> (for assets like datasets)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Run​Date</samp> (for assets like reports)
                  </li>

                  <li class="li"><samp class="codeph nolang">Status</samp></li>

                  <li class="li"><samp class="codeph nolang">Title</samp></li>

                  <li class="li"><samp class="codeph nolang">Type</samp></li>

                </ul>
              </td>

              <td class="entry" headers="d287284e163" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d287284e166" data-title="Available Version">38.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d287284e154" data-title="Parameter Name"><samp class="codeph nolang">template​Filters</samp></td>

              <td class="entry" headers="d287284e157" data-title="Type">Connect​Wave​Template​Search​Filters​Enum</td>

              <td class="entry" headers="d287284e160" data-title="Description">The filter templates to apply to the returned collection. Valid values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Apps​Constructed​By​Template</samp></li>

                  <li class="li"><samp class="codeph nolang">Apps​With​Install​History</samp></li>

                </ul>
              </td>

              <td class="entry" headers="d287284e163" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d287284e166" data-title="Available Version">57.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d287284e154" data-title="Parameter Name"><samp class="codeph nolang">template​Source​Id</samp></td>

              <td class="entry" headers="d287284e157" data-title="Type">String</td>

              <td class="entry" headers="d287284e160" data-title="Description">Filters the results to include only a collection of folders created from
                a specific template source</td>

              <td class="entry" headers="d287284e163" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d287284e166" data-title="Available Version">36.0</td>

            </tr>

          </tbody>

        </table>

## Response body for GET

[Wave Folder Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_folder_collection.htm "A collection of Analytics folders.")

## Request body for POST

This is a [Wave Folder Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_input.htm "An Analytics folder. This implements BaseWaveFolderInput.") or a [Wave Folder Template Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_template_input.htm "A templated Analytics folder. This implements BaseWaveFolderInput."), both of which implement the [Base Wave Folder Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_wave_folder_input.htm "The base Analytics folder asset.").

## Response body for POST

[Wave Folder](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_folder.htm "An Analytics folder.")