---
title: "Get gadgets"
method: GET
path: "/rest/api/3/dashboard/{dashboardId}/gadget"
tags: ["Dashboards"]
---

# Get gadgets

`GET /rest/api/3/dashboard/{dashboardId}/gadget`

## Request

- Base URL: `https://your-domain.atlassian.net`
- URL: `https://your-domain.atlassian.net/rest/api/3/dashboard/{dashboardId}/gadget`
- Auth: one of:
  - HTTP basic
  - OAuth 2
    - Authorization code: `https://auth.atlassian.com/authorize`
    - Token URL: `https://auth.atlassian.com/oauth/token` scopes: `read:jira-work`
  - none

Returns a list of dashboard gadgets on a dashboard.

This operation returns:

 *  Gadgets from a list of IDs, when `id` is set.
 *  Gadgets with a module key, when `moduleKey` is set.
 *  Gadgets from a list of URIs, when `uri` is set.
 *  All gadgets, when no other parameters are set.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** None.

## Path parameters

- `dashboardId` integer, required

## Query parameters

- `moduleKey` string[]
- `uri` string[]
- `gadgetId` integer[]

## Response `200`

Returned if the request is successful.

- DashboardGadgetResponse: The list of gadgets on the dashboard.
  - `gadgets` DashboardGadget[], required: The list of gadgets.
    - `color` 'blue' | 'red' | 'yellow' | 'green' | 'cyan' | 'purple' | 'gray' | 'white', required: The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`.
    - `id` integer, required: The ID of the gadget instance.
    - `moduleKey` string: The module key of the gadget type.
    - `position` DashboardGadgetPosition, required: Details of a gadget position.
      - `The column position of the gadget.` integer, required
      - `The row position of the gadget.` integer, required
    - `title` string, required: The title of the gadget.
    - `uri` string: The URI of the gadget type.

## Other responses

- `401`: Returned if the authentication credentials are incorrect.
- `404`: Returned if the dashboard is not found.

---

[API](https://skmtc.dev/atlassian/apis/the-jira-cloud-platform-rest-api-2.md) - [All operations](https://skmtc.dev/atlassian/apis/the-jira-cloud-platform-rest-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/atlassian/apis/the-jira-cloud-platform-rest-api-2/revisions/f22db3da5feb?raw)