2022-05-26 10:06:25 -05:00
---
aliases:
- /docs/grafana/latest/developers/http_api/folder_dashboard_search/
- /docs/grafana/latest/http_api/folder_dashboard_search/
description: Grafana Folder/Dashboard Search HTTP API
keywords:
- grafana
- http
- documentation
- api
- search
- folder
- dashboard
title: 'Folder/Dashboard Search HTTP API '
---
2018-02-05 13:53:58 -06:00
# Folder/Dashboard Search API
## Search folders and dashboards
`GET /api/search/`
2022-05-27 07:42:51 -05:00
> Note: When using [Role-based access control]({{< relref "../../enterprise/access-control/" >}}), search results will contain only dashboards and folders which you have access to.
2022-05-20 14:48:52 -05:00
2018-02-05 13:53:58 -06:00
Query parameters:
- **query** – Search Query
- **tag** – List of tags to search for
- **type** – Type to search for, `dash-folder` or `dash-db`
- **dashboardIds** – List of dashboard id's to search for
- **folderIds** – List of folder id's to search in for dashboards
- **starred** – Flag indicating if only starred Dashboards should be returned
2022-02-23 06:28:39 -06:00
- **limit** – Limit the number of returned results (max is 5000; default is 1000)
2019-05-01 04:42:03 -05:00
- **page** – Use this parameter to access hits beyond limit. Numbering starts at 1. limit param acts as page size. Only available in Grafana v6.2+.
2018-02-05 13:53:58 -06:00
**Example request for retrieving folders and dashboards of the general folder**:
```http
GET /api/search?folderIds=0& query=& starred=false HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Example response for retrieving folders and dashboards of the general folder**:
```http
HTTP/1.1 200
Content-Type: application/json
[
{
"id": 163,
"uid": "000000163",
"title": "Folder",
"url": "/dashboards/f/000000163/folder",
"type": "dash-folder",
"tags": [],
"isStarred": false,
"uri":"db/folder" // deprecated in Grafana v5.0
},
{
"id":1,
"uid": "cIBgcSjkk",
"title":"Production Overview",
"url": "/d/cIBgcSjkk/production-overview",
"type":"dash-db",
"tags":[prod],
"isStarred":true,
"uri":"db/production-overview" // deprecated in Grafana v5.0
}
]
```
**Example request searching for dashboards**:
```http
GET /api/search?query=Production%20Overview& starred=true& tag=prod HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Example response searching for dashboards**:
```http
HTTP/1.1 200
Content-Type: application/json
[
{
"id":1,
"uid": "cIBgcSjkk",
"title":"Production Overview",
"url": "/d/cIBgcSjkk/production-overview",
"type":"dash-db",
"tags":[prod],
"isStarred":true,
"folderId": 2,
"folderUid": "000000163",
"folderTitle": "Folder",
"folderUrl": "/dashboards/f/000000163/folder",
"uri":"db/production-overview" // deprecated in Grafana v5.0
}
]
2019-04-17 06:07:50 -05:00
```