--- schema_version: "1" id: d7cbd20ec5b091d7f875674f21b2588008f013a802c395bf33055f0e4bb0bd62 title: Dashboards 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_dashboards.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards.htm source_site: developer.salesforce.com content_type: documentation content_hash: d1ada4119ad7375e4d28ebc35e1cc97f4821555f625b62b2cc1e34c86306b1a7 description: Returns a list of Analytics dashboard or creates a dashboard. --- # Dashboards List Resource Returns a list of Analytics dashboard or creates a dashboard. ## Resource URL /wave/dashboards ## Formats JSON ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getDashboardCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-348611a2-5c12-4744-bc3e-cd2d4b2c57a2?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 — [ listDashboards()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_asset.htm) ## HTTP Methods GET POST ## GET Request Parameters
Parameter Name Type Description Required or Optional Available Version
folder​Id ID Filters the results to include only the contents of a specific folder. The id can be the requesting user’s ID for items in the user’s private folder. Optional 36.0
ids String Filters the results to include only the dashboards with the specified ids. Optional 52.0
mobile​Only Boolean Filters the results for mobile enabled dashboards only. Optional 41.0
page String A generated token that indicates the view of dashboard to be returned. Optional 36.0
page​Size Integer The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. Optional 36.0
q String 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. Optional 36.0
scope Connect​Wave​Scope​Type​Enum The type of scope to be applied to the returned collection. Valid values are:
  • Created​By​Me
  • Mru (Most Recently Used)
  • Shared​With​Me
 Optional 38.0
sort Connect​Wave​Sort​Order​Type​Enum The type of sort order to be applied to the returned collection. Valid values are:
  • App
  • Created​By
  • Created​Date
  • Last​Modified
  • Last​Modified​By
  • Mru (Most Recently Used, last viewed date)
  • Name
  • Type
 Optional 38.0
template​Api​Name String Filters the results to include only a collection of dashboards created from a specific application template Optional 38.0
type Connect​Wave​Asset​Type​Enum The asset type. The default type is Dashboard. Valid types are:
  • Collection
  • Component
  • Dashboard
  • Dashboard​Saved​View
  • Dashboard​Snapshot
  • Data​Connector
  • Dataflow
  • Dataflow​Job
  • Dataflow​Job​Node
  • Dataset
  • Dataset​Shard
  • Dataset​Version
  • External​Data
  • Folder
  • Lens
  • Lightning​Component
  • Lightning​Dashboard
  • Lightning​Dashboard​Folder
  • Recipe
  • Recipe​Configuration
  • Recipe​Model
  • Replicated​Dataset
  • Report
  • Report​Folder
  • Story
  • Widget
  • Workflow
 Optional, Small, 36.0 36.0
## GET Response Body [Dashboard Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_collection.htm "A collection of Analytics dashboards.") ## POST Request Body [Dashboard Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_input.htm "An Analytics dashboard.") ## POST Response Body [Dashboard](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard.htm "An Analytics dashboard.")