Dashboards

Get all dashboards

Changed on

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.

get/rest/api/3/dashboard

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/dashboard
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:jira-work
    • or none

Query parameters

filter'my' | 'favourite'

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.
startAtinteger

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

maxResultsinteger

The maximum number of items to return per page.

Response

Returned if the request is successful.

maxResultsinteger

The maximum number of results that could be on the page.

nextstring

The URL of the next page of results, if any.

prevstring

The URL of the previous page of results, if any.

startAtinteger

The index of the first item returned on the page.

totalinteger

The number of results on the page.

Changes

  • 75c9c58763c9Revision changes
    • warning

      added the new product_discovery enum value to the ///////////////////// response property for the response status

    • warning

      added the new product_discovery enum value to the ///////// response property for the response status

    • warning

      added the new product_discovery enum value to the /////////////////// response property for the response status

    • warning

      added the new product_discovery enum value to the ///////////////////// response property for the response status

    • warning

      added the new product_discovery enum value to the ///////// response property for the response status

    • warning

      added the new product_discovery enum value to the /////////////////// response property for the response status

  • a4396bcf79c3Revision changes
    • info

      the response optional property /////////// became not read-only for the status

    • info

      the response optional property /////////// became not read-only for the status