Atlassian: Get all dashboards

Atlassian dashboards.getAllDashboards: arguments, response, policy and SDK examples.

Operation atlassian.getalldashboards

Provider route: GET /{cloudId}/rest/api/3/dashboard. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["dashboards"]["getAllDashboards"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.dashboards.getAllDashboards(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.dashboards.get_all_dashboards(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
`query`	object	Optional	Additional keys: not allowed
`query.filter`	string	Optional	One of: my, favourite
`query.startAt`	integer	Optional	Default: 0 Format: int32
`query.maxResults`	integer	Optional	Default: 20 Format: int32

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Get all dashboards — response body

Referenced models: Get all dashboards — response body

Schemas

27 more schemas are linked from the tables above, on the schema pages.

Get all dashboards — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A page containing dashboard details.
`dashboards`	JSON	Optional
`dashboards (anyOf 1)`	array	Alternative	List of dashboards. Read only: true
`dashboards (anyOf 1)[]`	Model	Each item	Expand Get dashboard — response body
`dashboards (anyOf 2)`	null	Alternative
`maxResults`	JSON	Optional
`maxResults (anyOf 1)`	JSON	Alternative
`maxResults (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum number of results that could be on the page. Format: int32 Read only: true
`maxResults (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`maxResults (anyOf 2)`	null	Alternative
`next`	JSON	Optional
`next (anyOf 1)`	string	Alternative	The URL of the next page of results, if any. Read only: true
`next (anyOf 2)`	null	Alternative
`prev`	JSON	Optional
`prev (anyOf 1)`	string	Alternative	The URL of the previous page of results, if any. Read only: true
`prev (anyOf 2)`	null	Alternative
`startAt`	JSON	Optional
`startAt (anyOf 1)`	JSON	Alternative
`startAt (anyOf 1) (anyOf 1)`	integer	Alternative	The index of the first item returned on the page. Format: int32 Read only: true
`startAt (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`startAt (anyOf 2)`	null	Alternative
`total`	JSON	Optional
`total (anyOf 1)`	JSON	Alternative
`total (anyOf 1) (anyOf 1)`	integer	Alternative	The number of results on the page. Format: int32 Read only: true
`total (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`total (anyOf 2)`	null	Alternative

Referenced models: Get dashboard — response body

Get dashboard — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a dashboard.
`automaticRefreshMs`	JSON	Optional
`automaticRefreshMs (anyOf 1)`	JSON	Alternative
`automaticRefreshMs (anyOf 1) (anyOf 1)`	integer	Alternative	The automatic refresh interval for the dashboard in milliseconds. Format: int32 Read only: true
`automaticRefreshMs (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`automaticRefreshMs (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`editPermissions`	JSON	Optional
`editPermissions (anyOf 1)`	array	Alternative	The details of any edit share permissions for the dashboard. Read only: true
`editPermissions (anyOf 1)[]`	Model	Each item	Expand Get share permission — response body
`editPermissions (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the dashboard. Read only: true
`id (anyOf 2)`	null	Alternative
`isFavourite`	JSON	Optional
`isFavourite (anyOf 1)`	boolean	Alternative	Whether the dashboard is selected as a favorite by the user. Read only: true
`isFavourite (anyOf 2)`	null	Alternative
`isWritable`	JSON	Optional
`isWritable (anyOf 1)`	boolean	Alternative	Whether the current user has permission to edit the dashboard. Read only: true
`isWritable (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the dashboard. Read only: true
`name (anyOf 2)`	null	Alternative
`owner`	JSON	Optional
`owner (anyOf 1)`	Model	Alternative	Expand Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self The owner of the dashboard. Read only: true
`owner (anyOf 2)`	null	Alternative
`popularity`	JSON	Optional
`popularity (anyOf 1)`	JSON	Alternative
`popularity (anyOf 1) (anyOf 1)`	integer	Alternative	The number of users who have this dashboard as a favorite. Format: int64 Read only: true
`popularity (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`popularity (anyOf 2)`	null	Alternative
`rank`	JSON	Optional
`rank (anyOf 1)`	JSON	Alternative
`rank (anyOf 1) (anyOf 1)`	integer	Alternative	The rank of this dashboard. Format: int32 Read only: true
`rank (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rank (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of these dashboard details. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative
`sharePermissions`	JSON	Optional
`sharePermissions (anyOf 1)`	array	Alternative	The details of any view share permissions for the dashboard. Read only: true
`sharePermissions (anyOf 1)[]`	Model	Each item	Expand Get share permission — response body
`sharePermissions (anyOf 2)`	null	Alternative
`systemDashboard`	JSON	Optional
`systemDashboard (anyOf 1)`	boolean	Alternative	Whether the current dashboard is system dashboard. Read only: true
`systemDashboard (anyOf 2)`	null	Alternative
`view`	JSON	Optional
`view (anyOf 1)`	string	Alternative	The URL of the dashboard. Read only: true
`view (anyOf 2)`	null	Alternative

Referenced models: Get share permission — response body, Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self

Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self

Field	Type	Presence	Description and constraints
`$`	object	Root
`accountId`	JSON	Optional
`accountId (anyOf 1)`	string	Alternative	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Maximum length: 128
`accountId (anyOf 2)`	null	Alternative
`active`	JSON	Optional
`active (anyOf 1)`	boolean	Alternative	Whether the user is active.
`active (anyOf 2)`	null	Alternative
`avatarUrls`	JSON	Optional
`avatarUrls (anyOf 1)`	Model	Alternative	Expand Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self avatar Urls 16x16, 24x24, 32x32, 48x48 The avatars of the user.
`avatarUrls (anyOf 2)`	null	Alternative
`displayName`	JSON	Optional
`displayName (anyOf 1)`	string	Alternative	The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
`displayName (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The key of the user.
`key (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The username of the user.
`name (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the user. Format: uri
`self (anyOf 2)`	null	Alternative

Referenced models: Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self avatar Urls 16x16, 24x24, 32x32, 48x48

Get project — response body — permissions Permissions which a user has on a project

Field	Type	Presence	Description and constraints
`$`	object	Root	Permissions which a user has on a project.
`canEdit`	JSON	Optional
`canEdit (anyOf 1)`	boolean	Alternative	Whether the logged user can edit the project. Read only: true
`canEdit (anyOf 2)`	null	Alternative

Get user — response body — groups callback, items, max-results, paging Callback, size callback object

Field	Type	Presence	Description and constraints
`$`	object	Root

Policy, approvals and errors

SDK function policy ID: atlassian.getalldashboards. Catalog operation: getalldashboards. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-work"]

Official provider source

Report an issue with this page