GET /rest/api/2/dashboard

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

This operation can be accessed anonymously.

Permissions required: None.

Servers

Query parameters

Name Type Required Description
startAt Integer No

The index of the first item to return in a page of results (page offset).

Default value: 0

maxResults Integer No

The maximum number of items to return per page.

Default value: 20

filter String No

The filter applied to the list of dashboards. Valid values are:

  • favourite Returns dashboards the user has marked as favorite.
  • my Returns dashboards owned by the user.

Possible values:

  • "my"
  • "favourite"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.