GET /rest/api/2/dashboard/search

Returns a paginated list of dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.

This operation can be accessed anonymously.

Permissions required: The following dashboards that match the query parameters are returned:

Dashboards owned by the user. Not returned for anonymous users.
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
Dashboards shared with a public project.
Dashboards shared with the public.

Servers

https://your-domain.atlassian.net

Query parameters

Name	Type	Required	Description
`projectId`	Integer	No	Project ID used to returns dashboards that are shared with a project that matches `sharePermissions.project.id`.
`startAt`	Integer	No	The index of the first item to return in a page of results (page offset). Default value: 0
`groupId`	String	No	Group ID used to return dashboards that are shared with a group that matches `sharePermissions.group.groupId`. This parameter cannot be used with the `groupname` parameter.
`maxResults`	Integer	No	The maximum number of items to return per page. Default value: 50
`dashboardName`	String	No	String used to perform a case-insensitive partial match with `name`.
`accountId`	String	No	User account ID used to return dashboards with the matching `owner.accountId`. This parameter cannot be used with the `owner` parameter.
`orderBy`	String	No	Order the results by a field: `description` Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use. `favourite_count` Sorts by dashboard popularity. `id` Sorts by dashboard ID. `is_favourite` Sorts by whether the dashboard is marked as a favorite. `name` Sorts by dashboard name. `owner` Sorts by dashboard owner name. Valid values: `"-description"` `"+owner"` `"description"` `"-id"` `"+id"` `"is_favorite"` `"owner"` `"-owner"` `"-is_favorite"` `"+is_favorite"` `"id"` `"name"` `"-name"` `"favorite_count"` `"-favorite_count"` `"+description"` `"+favorite_count"` `"+name"` Default value: "name"
`expand`	String	No	Use expand to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include: `description` Returns the description of the dashboard. `owner` Returns the owner of the dashboard. `viewUrl` Returns the URL that is used to view the dashboard. `favourite` Returns `isFavourite`, an indicator of whether the user has set the dashboard as a favorite. `favouritedCount` Returns `popularity`, a count of how many users have set this dashboard as a favorite. `sharePermissions` Returns details of the share permissions defined for the dashboard. `editPermissions` Returns details of the edit permissions defined for the dashboard. `isWritable` Returns whether the current user has permission to edit the dashboard.
`groupname`	String	No	As a group's name can change, use of `groupId` is recommended. Group name used to return dashboards that are shared with a group that matches `sharePermissions.group.name`. This parameter cannot be used with the `groupId` parameter.
`status`	String	No	The status to filter by. It may be active, archived or deleted. Valid values: `"active"` `"deleted"` `"archived"` Default value: "active"
`owner`	String	No	This parameter is deprecated because of privacy changes. Use `accountId` instead. See the migration guide for details. User name used to return dashboards with the matching `owner.name`. This parameter cannot be used with the `accountId` parameter.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.