{
"info": {
"_postman_id": "4c5c0139-0d97-4a2b-87b8-3131693ff4a3",
"name": "Atlassian rest/api/3/dashboard/",
"description": "Needs description.\n\nContact Support:\n Email: ecosystem@atlassian.com",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"createdAt": "2026-06-05T15:07:14.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"lastUpdatedBy": "35240",
"uid": "35240-4c5c0139-0d97-4a2b-87b8-3131693ff4a3"
},
"item": [
{
"name": "rest",
"item": [
{
"name": "api",
"item": [
{
"name": "3",
"item": [
{
"name": "dashboard",
"item": [
{
"name": "bulk",
"item": [
{
"name": "edit",
"item": [
{
"name": "Atlassian Bulk Edit Dashboards",
"id": "8274f6c8-cddc-4a85-be0e-7a51e988f6e1",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/BulkEditShareableEntityRequest not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/bulk/edit",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
"bulk",
"edit"
]
},
"description": "Bulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100.
**[Permissions](#permissions) required:** None
The dashboards to be updated must be owned by the user, or the user must be an administrator."
},
"response": [
{
"id": "b1cac76b-f983-4250-b213-bcb703b433b9",
"name": "Returned if the request is successful.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/BulkEditShareableEntityRequest not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/bulk/edit",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
"bulk",
"edit"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"action\": \"removePermission\",\n \"entityErrors\": {\n \"laborumf1\": {\n \"value\": \"reference #/components/schemas/BulkEditActionError not found in the OpenAPI spec\"\n }\n }\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-b1cac76b-f983-4250-b213-bcb703b433b9"
},
{
"id": "1a8bd620-469d-4e17-81ca-43d1c93567dc",
"name": "Returned if the request is not valid.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/BulkEditShareableEntityRequest not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/bulk/edit",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
"bulk",
"edit"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-1a8bd620-469d-4e17-81ca-43d1c93567dc"
},
{
"id": "32b22a92-5753-4801-8766-cec80465d5e2",
"name": "Returned if the authentication credentials are incorrect or missing.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/BulkEditShareableEntityRequest not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/bulk/edit",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
"bulk",
"edit"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-32b22a92-5753-4801-8766-cec80465d5e2"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-8274f6c8-cddc-4a85-be0e-7a51e988f6e1"
}
],
"id": "9b8fae6c-e2e6-4d25-af4b-beaac0e3f866",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-9b8fae6c-e2e6-4d25-af4b-beaac0e3f866"
}
],
"id": "b3525ec2-0a86-4bb7-a71b-bbb0ae7b7805",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-b3525ec2-0a86-4bb7-a71b-bbb0ae7b7805"
},
{
"name": "gadgets",
"item": [
{
"name": "Atlassian Get Available Gadgets",
"id": "cdd39087-ed3d-4247-9f23-2a19d959b8ee",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/gadgets",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
"gadgets"
]
},
"description": "Gets a list of all available gadgets that can be added to all dashboards.
**[Permissions](#permissions) required:** None."
},
"response": [
{
"id": "6bbffd12-5e9f-48c6-9f84-363cf2b6b7ca",
"name": "Returned if the request is successful.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/gadgets",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
"gadgets"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"gadgets\": [\n {\n \"value\": \"reference #/components/schemas/AvailableDashboardGadget not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/AvailableDashboardGadget not found in the OpenAPI spec\"\n }\n ]\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-6bbffd12-5e9f-48c6-9f84-363cf2b6b7ca"
},
{
"id": "092cc392-8bfe-43d0-a2f2-8e9752add263",
"name": "400 response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/gadgets",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
"gadgets"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-092cc392-8bfe-43d0-a2f2-8e9752add263"
},
{
"id": "87923e6b-394c-4848-ad4b-91604b129322",
"name": "Returned if the authentication credentials are incorrect or missing.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/gadgets",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
"gadgets"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-87923e6b-394c-4848-ad4b-91604b129322"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-cdd39087-ed3d-4247-9f23-2a19d959b8ee"
}
],
"id": "f5f7e347-abe3-4077-ac1c-d9e7be5b9c4a",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-f5f7e347-abe3-4077-ac1c-d9e7be5b9c4a"
},
{
"name": "search",
"item": [
{
"name": "Atlassian Search For Dashboards",
"id": "8e0f1db0-7277-48de-9279-66e794037d80",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/search?dashboardName=&accountId=&owner=&groupname=&groupId=&projectId=&orderBy=name&startAt=0&maxResults=50&status=active&expand=",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
"search"
],
"query": [
{
"description": "String used to perform a case-insensitive partial match with `name`.",
"key": "dashboardName",
"value": ""
},
{
"description": "User account ID used to return dashboards with the matching `owner.accountId`. This parameter cannot be used with the `owner` parameter.",
"key": "accountId",
"value": ""
},
{
"description": "This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching `owner.name`. This parameter cannot be used with the `accountId` parameter.",
"key": "owner",
"value": ""
},
{
"description": "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.",
"key": "groupname",
"value": ""
},
{
"description": "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.",
"key": "groupId",
"value": ""
},
{
"description": "Project ID used to returns dashboards that are shared with a project that matches `sharePermissions.project.id`.",
"key": "projectId",
"value": ""
},
{
"description": "[Order](#ordering) the results by a field:\n\n * `description` Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use.\n * `favourite_count` Sorts by dashboard popularity.\n * `id` Sorts by dashboard ID.\n * `is_favourite` Sorts by whether the dashboard is marked as a favorite.\n * `name` Sorts by dashboard name.\n * `owner` Sorts by dashboard owner name.",
"key": "orderBy",
"value": "name"
},
{
"description": "The index of the first item to return in a page of results (page offset).",
"key": "startAt",
"value": "0"
},
{
"description": "The maximum number of items to return per page.",
"key": "maxResults",
"value": "50"
},
{
"description": "The status to filter by. It may be active, archived or deleted.",
"key": "status",
"value": "active"
},
{
"description": "Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `description` Returns the description of the dashboard.\n * `owner` Returns the owner of the dashboard.\n * `viewUrl` Returns the URL that is used to view the dashboard.\n * `favourite` Returns `isFavourite`, an indicator of whether the user has set the dashboard as a favorite.\n * `favouritedCount` Returns `popularity`, a count of how many users have set this dashboard as a favorite.\n * `sharePermissions` Returns details of the share permissions defined for the dashboard.\n * `editPermissions` Returns details of the edit permissions defined for the dashboard.\n * `isWritable` Returns whether the current user has permission to edit the dashboard.",
"key": "expand",
"value": ""
}
]
},
"description": "Returns a [paginated](#pagination) list of dashboards. This operation is similar to [Get dashboards](#api-rest-api-3-dashboard-get) 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](#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."
},
"response": [
{
"id": "a52cd9c2-9bc0-4243-b9ea-7b5be82ae8ec",
"name": "Returned if the request is successful.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/search?dashboardName=&accountId=&owner=&groupname=&groupId=&projectId=&orderBy=name&startAt=0&maxResults=50&status=active&expand=",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
"search"
],
"query": [
{
"description": "String used to perform a case-insensitive partial match with `name`.",
"key": "dashboardName",
"value": ""
},
{
"description": "User account ID used to return dashboards with the matching `owner.accountId`. This parameter cannot be used with the `owner` parameter.",
"key": "accountId",
"value": ""
},
{
"description": "This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching `owner.name`. This parameter cannot be used with the `accountId` parameter.",
"key": "owner",
"value": ""
},
{
"description": "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.",
"key": "groupname",
"value": ""
},
{
"description": "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.",
"key": "groupId",
"value": ""
},
{
"description": "Project ID used to returns dashboards that are shared with a project that matches `sharePermissions.project.id`.",
"key": "projectId",
"value": ""
},
{
"description": "[Order](#ordering) the results by a field:\n\n * `description` Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use.\n * `favourite_count` Sorts by dashboard popularity.\n * `id` Sorts by dashboard ID.\n * `is_favourite` Sorts by whether the dashboard is marked as a favorite.\n * `name` Sorts by dashboard name.\n * `owner` Sorts by dashboard owner name.",
"key": "orderBy",
"value": "name"
},
{
"description": "The index of the first item to return in a page of results (page offset).",
"key": "startAt",
"value": "0"
},
{
"description": "The maximum number of items to return per page.",
"key": "maxResults",
"value": "50"
},
{
"description": "The status to filter by. It may be active, archived or deleted.",
"key": "status",
"value": "active"
},
{
"description": "Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `description` Returns the description of the dashboard.\n * `owner` Returns the owner of the dashboard.\n * `viewUrl` Returns the URL that is used to view the dashboard.\n * `favourite` Returns `isFavourite`, an indicator of whether the user has set the dashboard as a favorite.\n * `favouritedCount` Returns `popularity`, a count of how many users have set this dashboard as a favorite.\n * `sharePermissions` Returns details of the share permissions defined for the dashboard.\n * `editPermissions` Returns details of the edit permissions defined for the dashboard.\n * `isWritable` Returns whether the current user has permission to edit the dashboard.",
"key": "expand",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"isLast\": \"\",\n \"maxResults\": \"\",\n \"nextPage\": \"\",\n \"self\": \"\",\n \"startAt\": \"\",\n \"total\": \"\",\n \"values\": [\n {\n \"automaticRefreshMs\": \"\",\n \"description\": \"\",\n \"editPermissions\": [\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n }\n ],\n \"id\": \"\",\n \"isFavourite\": \"\",\n \"isWritable\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"description\": \"The owner of the dashboard.\",\n \"readOnly\": true,\n \"value\": \"reference #/components/schemas/UserBean not found in the OpenAPI spec\"\n },\n \"popularity\": \"\",\n \"rank\": \"\",\n \"self\": \"\",\n \"sharePermissions\": [\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n }\n ],\n \"systemDashboard\": \"\",\n \"view\": \"\"\n },\n {\n \"automaticRefreshMs\": \"\",\n \"description\": \"\",\n \"editPermissions\": [\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n }\n ],\n \"id\": \"\",\n \"isFavourite\": \"\",\n \"isWritable\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"description\": \"The owner of the dashboard.\",\n \"readOnly\": true,\n \"value\": \"reference #/components/schemas/UserBean not found in the OpenAPI spec\"\n },\n \"popularity\": \"\",\n \"rank\": \"\",\n \"self\": \"\",\n \"sharePermissions\": [\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n }\n ],\n \"systemDashboard\": \"\",\n \"view\": \"\"\n }\n ]\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-a52cd9c2-9bc0-4243-b9ea-7b5be82ae8ec"
},
{
"id": "45d95035-338e-4afa-a709-f4e57b829782",
"name": "Returned if:\n\n * `orderBy` is invalid.\n * `expand` includes an invalid value.\n * `accountId` and `owner` are provided.\n * `groupname` and `groupId` are provided.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/search?dashboardName=&accountId=&owner=&groupname=&groupId=&projectId=&orderBy=name&startAt=0&maxResults=50&status=active&expand=",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
"search"
],
"query": [
{
"description": "String used to perform a case-insensitive partial match with `name`.",
"key": "dashboardName",
"value": ""
},
{
"description": "User account ID used to return dashboards with the matching `owner.accountId`. This parameter cannot be used with the `owner` parameter.",
"key": "accountId",
"value": ""
},
{
"description": "This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching `owner.name`. This parameter cannot be used with the `accountId` parameter.",
"key": "owner",
"value": ""
},
{
"description": "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.",
"key": "groupname",
"value": ""
},
{
"description": "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.",
"key": "groupId",
"value": ""
},
{
"description": "Project ID used to returns dashboards that are shared with a project that matches `sharePermissions.project.id`.",
"key": "projectId",
"value": ""
},
{
"description": "[Order](#ordering) the results by a field:\n\n * `description` Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use.\n * `favourite_count` Sorts by dashboard popularity.\n * `id` Sorts by dashboard ID.\n * `is_favourite` Sorts by whether the dashboard is marked as a favorite.\n * `name` Sorts by dashboard name.\n * `owner` Sorts by dashboard owner name.",
"key": "orderBy",
"value": "name"
},
{
"description": "The index of the first item to return in a page of results (page offset).",
"key": "startAt",
"value": "0"
},
{
"description": "The maximum number of items to return per page.",
"key": "maxResults",
"value": "50"
},
{
"description": "The status to filter by. It may be active, archived or deleted.",
"key": "status",
"value": "active"
},
{
"description": "Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `description` Returns the description of the dashboard.\n * `owner` Returns the owner of the dashboard.\n * `viewUrl` Returns the URL that is used to view the dashboard.\n * `favourite` Returns `isFavourite`, an indicator of whether the user has set the dashboard as a favorite.\n * `favouritedCount` Returns `popularity`, a count of how many users have set this dashboard as a favorite.\n * `sharePermissions` Returns details of the share permissions defined for the dashboard.\n * `editPermissions` Returns details of the edit permissions defined for the dashboard.\n * `isWritable` Returns whether the current user has permission to edit the dashboard.",
"key": "expand",
"value": ""
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-45d95035-338e-4afa-a709-f4e57b829782"
},
{
"id": "d726310f-dab3-42c2-b1a2-d4cb2d355cc1",
"name": "401 response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/search?dashboardName=&accountId=&owner=&groupname=&groupId=&projectId=&orderBy=name&startAt=0&maxResults=50&status=active&expand=",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
"search"
],
"query": [
{
"description": "String used to perform a case-insensitive partial match with `name`.",
"key": "dashboardName",
"value": ""
},
{
"description": "User account ID used to return dashboards with the matching `owner.accountId`. This parameter cannot be used with the `owner` parameter.",
"key": "accountId",
"value": ""
},
{
"description": "This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching `owner.name`. This parameter cannot be used with the `accountId` parameter.",
"key": "owner",
"value": ""
},
{
"description": "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.",
"key": "groupname",
"value": ""
},
{
"description": "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.",
"key": "groupId",
"value": ""
},
{
"description": "Project ID used to returns dashboards that are shared with a project that matches `sharePermissions.project.id`.",
"key": "projectId",
"value": ""
},
{
"description": "[Order](#ordering) the results by a field:\n\n * `description` Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use.\n * `favourite_count` Sorts by dashboard popularity.\n * `id` Sorts by dashboard ID.\n * `is_favourite` Sorts by whether the dashboard is marked as a favorite.\n * `name` Sorts by dashboard name.\n * `owner` Sorts by dashboard owner name.",
"key": "orderBy",
"value": "name"
},
{
"description": "The index of the first item to return in a page of results (page offset).",
"key": "startAt",
"value": "0"
},
{
"description": "The maximum number of items to return per page.",
"key": "maxResults",
"value": "50"
},
{
"description": "The status to filter by. It may be active, archived or deleted.",
"key": "status",
"value": "active"
},
{
"description": "Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `description` Returns the description of the dashboard.\n * `owner` Returns the owner of the dashboard.\n * `viewUrl` Returns the URL that is used to view the dashboard.\n * `favourite` Returns `isFavourite`, an indicator of whether the user has set the dashboard as a favorite.\n * `favouritedCount` Returns `popularity`, a count of how many users have set this dashboard as a favorite.\n * `sharePermissions` Returns details of the share permissions defined for the dashboard.\n * `editPermissions` Returns details of the edit permissions defined for the dashboard.\n * `isWritable` Returns whether the current user has permission to edit the dashboard.",
"key": "expand",
"value": ""
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-d726310f-dab3-42c2-b1a2-d4cb2d355cc1"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-8e0f1db0-7277-48de-9279-66e794037d80"
}
],
"id": "804f5150-7144-4641-b712-5a72888f2c35",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-804f5150-7144-4641-b712-5a72888f2c35"
},
{
"name": "{dashboardId}",
"item": [
{
"name": "gadget",
"item": [
{
"name": "{gadgetId}",
"item": [
{
"name": "Atlassian Remove Gadget From Dashboard",
"id": "265acd38-0769-4db2-8dcf-b7143675b20e",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget/:gadgetId",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget",
":gadgetId"
],
"variable": [
{
"id": "3fe6fa1b-2460-49d8-b420-ed3aabe4bdb2",
"key": "dashboardId",
"value": "",
"description": "(Required) The ID of the dashboard."
},
{
"id": "864c5693-6a40-4fbd-8839-69b7be344ae5",
"key": "gadgetId",
"value": "",
"description": "(Required) The ID of the gadget."
}
]
},
"description": "Removes a dashboard gadget from a dashboard.
When a gadget is removed from a dashboard, other gadgets in the same column are moved up to fill the emptied position.
**[Permissions](#permissions) required:** None."
},
"response": [
{
"id": "e5517d01-766c-4698-9ff8-5adce94f7fe4",
"name": "Returned if the request is successful.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget/:gadgetId",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget",
":gadgetId"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "gadgetId"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-e5517d01-766c-4698-9ff8-5adce94f7fe4"
},
{
"id": "bcbaa62d-cbcf-4aad-8bcc-4abaa63ccc3a",
"name": "Returned if the authentication credentials are incorrect or missing.",
"originalRequest": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget/:gadgetId",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget",
":gadgetId"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "gadgetId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"responseTime": null,
"body": null,
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-bcbaa62d-cbcf-4aad-8bcc-4abaa63ccc3a"
},
{
"id": "8e408fa6-f938-4c00-a3a5-ecf2bae6e9c3",
"name": "Returned if the gadget or the dashboard is not found.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget/:gadgetId",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget",
":gadgetId"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "gadgetId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-8e408fa6-f938-4c00-a3a5-ecf2bae6e9c3"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-265acd38-0769-4db2-8dcf-b7143675b20e"
},
{
"name": "Atlassian Update Gadget On Dashboard",
"id": "371c9a9c-72c2-455b-ad84-47a9751153d8",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardGadgetUpdateRequest not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget/:gadgetId",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget",
":gadgetId"
],
"variable": [
{
"id": "b19a8837-fff3-4d1c-a72e-e9a085607017",
"key": "dashboardId",
"value": "",
"description": "(Required) The ID of the dashboard."
},
{
"id": "68b83acd-1898-4485-a505-38eb7a926e9a",
"key": "gadgetId",
"value": "",
"description": "(Required) The ID of the gadget."
}
]
},
"description": "Changes the title, position, and color of the gadget on a dashboard.
**[Permissions](#permissions) required:** None."
},
"response": [
{
"id": "244ef51f-b3fa-46e1-8811-08016b812b6f",
"name": "Returned if the request is successful.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardGadgetUpdateRequest not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget/:gadgetId",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget",
":gadgetId"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "gadgetId"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-244ef51f-b3fa-46e1-8811-08016b812b6f"
},
{
"id": "13bcdd51-b51c-40c7-a6d0-cbf967594065",
"name": "Returned if the request is invalid.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardGadgetUpdateRequest not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget/:gadgetId",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget",
":gadgetId"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "gadgetId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-13bcdd51-b51c-40c7-a6d0-cbf967594065"
},
{
"id": "956bc85b-a237-4d89-8926-3e9b2abb0bfb",
"name": "Returned if the authentication credentials are incorrect.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardGadgetUpdateRequest not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget/:gadgetId",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget",
":gadgetId"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "gadgetId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"responseTime": null,
"body": null,
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-956bc85b-a237-4d89-8926-3e9b2abb0bfb"
},
{
"id": "b73dd7e4-d9ce-4ff6-9f93-2e09f653744f",
"name": "Returned if the gadget or the dashboard is not found.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardGadgetUpdateRequest not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget/:gadgetId",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget",
":gadgetId"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "gadgetId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-b73dd7e4-d9ce-4ff6-9f93-2e09f653744f"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-371c9a9c-72c2-455b-ad84-47a9751153d8"
}
],
"id": "b792dad3-cdf7-4cc9-9f07-f7817e27a2bb",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-b792dad3-cdf7-4cc9-9f07-f7817e27a2bb"
},
{
"name": "Atlassian Get Gadgets",
"id": "43a0a05f-8bae-4ae3-9a3b-bd90ba7caa21",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget?moduleKey=&moduleKey=&uri=&uri=&gadgetId=&gadgetId=",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget"
],
"query": [
{
"description": "The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: `moduleKey=key:one&moduleKey=key:two`.",
"key": "moduleKey",
"value": ""
},
{
"description": "The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: `moduleKey=key:one&moduleKey=key:two`.",
"key": "moduleKey",
"value": ""
},
{
"description": "The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: `uri=/rest/example/uri/1&uri=/rest/example/uri/2`.",
"key": "uri",
"value": ""
},
{
"description": "The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: `uri=/rest/example/uri/1&uri=/rest/example/uri/2`.",
"key": "uri",
"value": ""
},
{
"description": "The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: `gadgetId=10000&gadgetId=10001`.",
"key": "gadgetId",
"value": ""
},
{
"description": "The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: `gadgetId=10000&gadgetId=10001`.",
"key": "gadgetId",
"value": ""
}
],
"variable": [
{
"id": "b307a534-8e20-4618-9531-9a2e9aa594ed",
"key": "dashboardId",
"value": "",
"description": "(Required) The ID of the dashboard."
}
]
},
"description": "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."
},
"response": [
{
"id": "937f1481-7762-43e5-b8e2-c21f519dfed7",
"name": "Returned if the request is successful.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget?moduleKey=&uri=&gadgetId=",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget"
],
"query": [
{
"description": "The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: `moduleKey=key:one&moduleKey=key:two`.",
"key": "moduleKey",
"value": ""
},
{
"description": "The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: `uri=/rest/example/uri/1&uri=/rest/example/uri/2`.",
"key": "uri",
"value": ""
},
{
"description": "The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: `gadgetId=10000&gadgetId=10001`.",
"key": "gadgetId",
"value": ""
}
],
"variable": [
{
"key": "dashboardId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"gadgets\": [\n {\n \"color\": \"gray\",\n \"id\": \"\",\n \"position\": {\n \"description\": \"The position of the gadget.\",\n \"readOnly\": true,\n \"value\": \"reference #/components/schemas/DashboardGadgetPosition not found in the OpenAPI spec\"\n },\n \"title\": \"\",\n \"moduleKey\": \"\",\n \"uri\": \"\"\n },\n {\n \"color\": \"green\",\n \"id\": \"\",\n \"position\": {\n \"description\": \"The position of the gadget.\",\n \"readOnly\": true,\n \"value\": \"reference #/components/schemas/DashboardGadgetPosition not found in the OpenAPI spec\"\n },\n \"title\": \"\",\n \"moduleKey\": \"\",\n \"uri\": \"\"\n }\n ]\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-937f1481-7762-43e5-b8e2-c21f519dfed7"
},
{
"id": "43ddc546-9961-4de6-85b4-6034b003fc3c",
"name": "Returned if the authentication credentials are incorrect.",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget?moduleKey=&uri=&gadgetId=",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget"
],
"query": [
{
"description": "The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: `moduleKey=key:one&moduleKey=key:two`.",
"key": "moduleKey",
"value": ""
},
{
"description": "The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: `uri=/rest/example/uri/1&uri=/rest/example/uri/2`.",
"key": "uri",
"value": ""
},
{
"description": "The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: `gadgetId=10000&gadgetId=10001`.",
"key": "gadgetId",
"value": ""
}
],
"variable": [
{
"key": "dashboardId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"responseTime": null,
"body": null,
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-43ddc546-9961-4de6-85b4-6034b003fc3c"
},
{
"id": "10eff555-a57a-4646-a0ff-a557407df8b6",
"name": "Returned if the dashboard is not found.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget?moduleKey=&uri=&gadgetId=",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget"
],
"query": [
{
"description": "The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: `moduleKey=key:one&moduleKey=key:two`.",
"key": "moduleKey",
"value": ""
},
{
"description": "The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: `uri=/rest/example/uri/1&uri=/rest/example/uri/2`.",
"key": "uri",
"value": ""
},
{
"description": "The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: `gadgetId=10000&gadgetId=10001`.",
"key": "gadgetId",
"value": ""
}
],
"variable": [
{
"key": "dashboardId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-10eff555-a57a-4646-a0ff-a557407df8b6"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-43a0a05f-8bae-4ae3-9a3b-bd90ba7caa21"
},
{
"name": "Atlassian Add Gadget To Dashboard",
"id": "248676ea-77d9-4e07-a592-25924a4b492d",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardGadgetSettings not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget"
],
"variable": [
{
"id": "c3b16764-ffeb-4e7b-9a76-66d0552ffcae",
"key": "dashboardId",
"value": "",
"description": "(Required) The ID of the dashboard."
}
]
},
"description": "Adds a gadget to a dashboard.
**[Permissions](#permissions) required:** None."
},
"response": [
{
"id": "e49d253f-99fb-4dfb-97f1-11fe5ab30b68",
"name": "Returned if the request is successful.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardGadgetSettings not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget"
],
"variable": [
{
"key": "dashboardId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"color\": \"red\",\n \"id\": \"\",\n \"position\": {\n \"description\": \"The position of the gadget.\",\n \"readOnly\": true,\n \"value\": \"reference #/components/schemas/DashboardGadgetPosition not found in the OpenAPI spec\"\n },\n \"title\": \"\",\n \"moduleKey\": \"\",\n \"uri\": \"\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-e49d253f-99fb-4dfb-97f1-11fe5ab30b68"
},
{
"id": "8351db3c-8b1c-4a14-88d2-a5b6188e11cf",
"name": "Returned if the request is invalid.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardGadgetSettings not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget"
],
"variable": [
{
"key": "dashboardId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-8351db3c-8b1c-4a14-88d2-a5b6188e11cf"
},
{
"id": "bb69d75f-cad9-48bd-9164-0224dcdb4025",
"name": "Returned if the authentication credentials are incorrect or missing.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardGadgetSettings not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget"
],
"variable": [
{
"key": "dashboardId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"responseTime": null,
"body": null,
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-bb69d75f-cad9-48bd-9164-0224dcdb4025"
},
{
"id": "65b49624-e8c3-4f3f-9838-7793444bb56e",
"name": "Returned if the dashboard is not found.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardGadgetSettings not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/gadget",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"gadget"
],
"variable": [
{
"key": "dashboardId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-65b49624-e8c3-4f3f-9838-7793444bb56e"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-248676ea-77d9-4e07-a592-25924a4b492d"
}
],
"id": "5fc089a5-1459-4caf-a1d9-8498d08e40bc",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-5fc089a5-1459-4caf-a1d9-8498d08e40bc"
},
{
"name": "items",
"item": [
{
"name": "{itemId}",
"item": [
{
"name": "properties",
"item": [
{
"name": "{propertyKey}",
"item": [
{
"name": "Atlassian Delete Dashboard Item Property",
"id": "58bad412-812a-4106-9c54-1d8c6155b682",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"id": "609b81f2-d2b7-4ec8-a0bc-e441433a6847",
"key": "dashboardId",
"value": "",
"description": "(Required) The ID of the dashboard."
},
{
"id": "079fd62f-8666-4cda-81b4-78c52baca506",
"key": "itemId",
"value": "",
"description": "(Required) The ID of the dashboard item."
},
{
"id": "2a69c578-71f7-4514-9227-e179ed70f3a1",
"key": "propertyKey",
"value": "",
"description": "(Required) The key of the dashboard item property."
}
]
},
"description": "Deletes a dashboard item property.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** The user must be the owner of the dashboard. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard."
},
"response": [
{
"id": "6efcab47-edd8-4f72-bb25-00f15b3484cb",
"name": "Returned if the dashboard item property is deleted.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-6efcab47-edd8-4f72-bb25-00f15b3484cb"
},
{
"id": "d9895f15-2d14-41a1-ac27-50868fa72868",
"name": "Returned if the dashboard or dashboard item ID is invalid.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-d9895f15-2d14-41a1-ac27-50868fa72868"
},
{
"id": "9917a8c4-d55a-461e-9916-212449b6c323",
"name": "Returned if the authentication credentials are incorrect or missing.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-9917a8c4-d55a-461e-9916-212449b6c323"
},
{
"id": "b36f9089-3e4f-4d67-86f3-9bdc167b5b26",
"name": "Returned if the user is not the owner of the dashboard.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-b36f9089-3e4f-4d67-86f3-9bdc167b5b26"
},
{
"id": "35c03d7e-1c69-4033-a9d7-99ae9fd122ef",
"name": "Returned if the dashboard item is not found or the dashboard is not shared with the user.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-35c03d7e-1c69-4033-a9d7-99ae9fd122ef"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-58bad412-812a-4106-9c54-1d8c6155b682"
},
{
"name": "Atlassian Get Dashboard Item Property",
"id": "ad4676eb-61da-4fa2-ac9c-cddaf45f8452",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"id": "d6b62aac-1639-499f-9d45-89b79079fd5c",
"key": "dashboardId",
"value": "",
"description": "(Required) The ID of the dashboard."
},
{
"id": "9f2149ac-0b2f-4499-94a8-ee7e27034a66",
"key": "itemId",
"value": "",
"description": "(Required) The ID of the dashboard item."
},
{
"id": "7df696c8-ee16-40d6-aed1-3a4230d582be",
"key": "propertyKey",
"value": "",
"description": "(Required) The key of the dashboard item property."
}
]
},
"description": "Returns the key and value of a dashboard item property.
A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see [Adding and customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ).
When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see [ Building a dashboard item for a JIRA Connect add-on](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/) and the [Dashboard Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/) documentation.
There is no resource to set or get dashboard items.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** The user must be the owner of the dashboard or have the dashboard shared with them. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users, and is accessible to anonymous users when Jira\\\\u2019s anonymous access is permitted."
},
"response": [
{
"id": "3973312f-0f7f-4784-bd53-2e2b4631587e",
"name": "Returned if the request is successful.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"key\": \"\",\n \"value\": {\n \"description\": \"The value of the property. Required on create and update.\"\n }\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-3973312f-0f7f-4784-bd53-2e2b4631587e"
},
{
"id": "792f31ba-cd11-4314-9856-d6699236f33e",
"name": "Returned if the authentication credentials are incorrect or missing.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-792f31ba-cd11-4314-9856-d6699236f33e"
},
{
"id": "844d9314-8a05-4a12-8e29-5e61d41fd430",
"name": "Returned if the dashboard, the dashboard item, or dashboard item property is not found, or the dashboard is not owned by or shared with the user.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-844d9314-8a05-4a12-8e29-5e61d41fd430"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-ad4676eb-61da-4fa2-ac9c-cddaf45f8452"
},
{
"name": "Atlassian Set Dashboard Item Property",
"id": "f7f56608-0f9d-4ec5-88f6-d82e0b5e4396",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"id": "bc605450-c538-4c3d-83c8-86c8a0e2d71c",
"key": "dashboardId",
"value": "",
"description": "(Required) The ID of the dashboard."
},
{
"id": "ae1c6214-39de-47bc-8880-33406f482f20",
"key": "itemId",
"value": "",
"description": "(Required) The ID of the dashboard item."
},
{
"id": "5c202fbc-19b5-49ff-b7c2-bf68aafcbdbc",
"key": "propertyKey",
"value": "",
"description": "(Required) The key of the dashboard item property. The maximum length is 255 characters. For dashboard items with a spec URI and no complete module key, if the provided propertyKey is equal to \"config\", the request body's JSON must be an object with all keys and values as strings."
}
]
},
"description": "Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.
A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see [Adding and customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ).
When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see [ Building a dashboard item for a JIRA Connect add-on](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/) and the [Dashboard Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/) documentation.
There is no resource to set or get dashboard items.
The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** The user must be the owner of the dashboard. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard."
},
"response": [
{
"id": "dd97eab8-ca20-456f-ac3b-29b1f7a14171",
"name": "Returned if the dashboard item property is updated.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-dd97eab8-ca20-456f-ac3b-29b1f7a14171"
},
{
"id": "ee7384d7-990f-461f-a7a7-4e4d505cf588",
"name": "Returned if the dashboard item property is created.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-ee7384d7-990f-461f-a7a7-4e4d505cf588"
},
{
"id": "6377bd9e-2361-4dac-9ca2-38ce44909485",
"name": "Returned if:\n\n * Request is invalid\n * Or if all of these conditions are met in the request:\n \n * The dashboard item has a spec URI and no complete module key\n * The value of propertyKey is equal to \"config\"\n * The request body contain",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-6377bd9e-2361-4dac-9ca2-38ce44909485"
},
{
"id": "912ce904-8c5f-41a5-b828-e831cb5997ef",
"name": "Returned if the authentication credentials are incorrect or missing.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-912ce904-8c5f-41a5-b828-e831cb5997ef"
},
{
"id": "96c63ce1-bc86-4696-8a69-81c8e9ed48da",
"name": "Returned if the user is not the owner of the dashboard.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-96c63ce1-bc86-4696-8a69-81c8e9ed48da"
},
{
"id": "30c0eae4-486f-4ec6-b3a8-a174c1ee7f36",
"name": "Returned if the dashboard item is not found or the dashboard is not shared with the user.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties",
":propertyKey"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
},
{
"key": "propertyKey"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-30c0eae4-486f-4ec6-b3a8-a174c1ee7f36"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-f7f56608-0f9d-4ec5-88f6-d82e0b5e4396"
}
],
"id": "e8e04cd2-6d44-4c93-ae31-8ab423d70f3c",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-e8e04cd2-6d44-4c93-ae31-8ab423d70f3c"
},
{
"name": "Atlassian Get Dashboard Item Property Keys",
"id": "55813c3d-97a5-4bcf-8d91-55fecbec0317",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties"
],
"variable": [
{
"id": "ab0588cd-f20e-49d7-a479-030e3e56e5d1",
"key": "dashboardId",
"value": "",
"description": "(Required) The ID of the dashboard."
},
{
"id": "fa7d853c-1bd4-4b76-ad09-9ec375594457",
"key": "itemId",
"value": "",
"description": "(Required) The ID of the dashboard item."
}
]
},
"description": "Returns the keys of all properties for a dashboard item.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** The user must be the owner of the dashboard or have the dashboard shared with them. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users, and is accessible to anonymous users when Jira\\\\u2019s anonymous access is permitted."
},
"response": [
{
"id": "b5a9c65d-3eb1-4276-8609-36d7883bccd6",
"name": "Returned if the request is successful.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"keys\": [\n {\n \"value\": \"reference #/components/schemas/PropertyKey not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/PropertyKey not found in the OpenAPI spec\"\n }\n ]\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-b5a9c65d-3eb1-4276-8609-36d7883bccd6"
},
{
"id": "72b45869-b216-4a74-8941-bec4fb852859",
"name": "Returned if the authentication credentials are incorrect or missing.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-72b45869-b216-4a74-8941-bec4fb852859"
},
{
"id": "ef2bfef7-1f4f-4b9b-8d85-a9f2e4f7a070",
"name": "Returned if the dashboard or dashboard item is not found, or the dashboard is not owned by or shared with the user.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:dashboardId/items/:itemId/properties",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":dashboardId",
"items",
":itemId",
"properties"
],
"variable": [
{
"key": "dashboardId"
},
{
"key": "itemId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-ef2bfef7-1f4f-4b9b-8d85-a9f2e4f7a070"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-55813c3d-97a5-4bcf-8d91-55fecbec0317"
}
],
"id": "6dd28e98-ac13-457d-838a-2799eab76f6a",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-6dd28e98-ac13-457d-838a-2799eab76f6a"
}
],
"id": "b59b4f95-d056-4364-8a37-483b86743545",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-b59b4f95-d056-4364-8a37-483b86743545"
}
],
"id": "d116f38b-78d5-46d4-a206-2e0dfcbe37ac",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-d116f38b-78d5-46d4-a206-2e0dfcbe37ac"
}
],
"id": "9357e93f-381b-433c-adaa-19e704fbb5fd",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-9357e93f-381b-433c-adaa-19e704fbb5fd"
},
{
"name": "{id}",
"item": [
{
"name": "copy",
"item": [
{
"name": "Atlassian Copy Dashboard",
"id": "3fad3a81-a0ea-408e-af23-e76285ce445d",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardDetails not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id/copy",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id",
"copy"
],
"variable": [
{
"id": "5f1202ae-34d6-4dba-a5d0-d185d1b9f9ac",
"key": "id",
"value": "",
"description": "(Required) "
}
]
},
"description": "Copies a dashboard. Any values provided in the `dashboard` parameter replace those in the copied dashboard.
**[Permissions](#permissions) required:** None
The dashboard to be copied must be owned by or shared with the user."
},
"response": [
{
"id": "bb40e54b-eba4-4707-8f79-e57c37f26fe4",
"name": "Returned if the request is successful.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardDetails not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id/copy",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id",
"copy"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"automaticRefreshMs\": \"\",\n \"description\": \"\",\n \"editPermissions\": [\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n }\n ],\n \"id\": \"\",\n \"isFavourite\": \"\",\n \"isWritable\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"description\": \"The owner of the dashboard.\",\n \"readOnly\": true,\n \"value\": \"reference #/components/schemas/UserBean not found in the OpenAPI spec\"\n },\n \"popularity\": \"\",\n \"rank\": \"\",\n \"self\": \"\",\n \"sharePermissions\": [\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n }\n ],\n \"systemDashboard\": \"\",\n \"view\": \"\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-bb40e54b-eba4-4707-8f79-e57c37f26fe4"
},
{
"id": "fbdeb4fb-f46b-4dd3-83b9-592743e2b1af",
"name": "Returned if the request is not valid.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardDetails not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id/copy",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id",
"copy"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-fbdeb4fb-f46b-4dd3-83b9-592743e2b1af"
},
{
"id": "aadaefbd-8704-40ba-97e2-aabbacd2a9a5",
"name": "Returned if the authentication credentials are incorrect or missing.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardDetails not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id/copy",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id",
"copy"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-aadaefbd-8704-40ba-97e2-aabbacd2a9a5"
},
{
"id": "78a0d98c-6580-47b7-a42b-9a0a4ec4a120",
"name": "Returned if the dashboard is not found or the dashboard is not owned by or shared with the user.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardDetails not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id/copy",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id",
"copy"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-78a0d98c-6580-47b7-a42b-9a0a4ec4a120"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-3fad3a81-a0ea-408e-af23-e76285ce445d"
}
],
"id": "0348169c-7f65-4158-a6ec-4ab2bb761807",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-0348169c-7f65-4158-a6ec-4ab2bb761807"
},
{
"name": "Atlassian Delete Dashboard",
"id": "25cef80d-ad65-4487-b962-df608f30fb92",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "noauth"
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"id": "de963e67-5415-467b-9cf1-72b018317807",
"key": "id",
"value": "",
"description": "(Required) The ID of the dashboard."
}
]
},
"description": "Deletes a dashboard.
**[Permissions](#permissions) required:** None
The dashboard to be deleted must be owned by the user."
},
"response": [
{
"id": "14005783-f039-41ef-a9b2-1dcb8c8f7917",
"name": "Returned if the dashboard is deleted.",
"originalRequest": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"responseTime": null,
"body": null,
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-14005783-f039-41ef-a9b2-1dcb8c8f7917"
},
{
"id": "a4564031-5ec9-4cd4-96a7-c9c54862c975",
"name": "400 response",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-a4564031-5ec9-4cd4-96a7-c9c54862c975"
},
{
"id": "a92bf29c-cd61-4e14-9ffe-16f20ceaec11",
"name": "Returned if the authentication credentials are incorrect or missing.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-a92bf29c-cd61-4e14-9ffe-16f20ceaec11"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-25cef80d-ad65-4487-b962-df608f30fb92"
},
{
"name": "Atlassian Get Dashboard",
"id": "d03ba6f7-cacf-4ad2-b2c5-0f015997b43b",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"id": "e8267b68-7254-4277-95f0-d8c903b4c2c4",
"key": "id",
"value": "",
"description": "(Required) The ID of the dashboard."
}
]
},
"description": "Returns a dashboard.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** None.
However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users."
},
"response": [
{
"id": "51e37142-7094-4ef4-9a60-5b76e0e17740",
"name": "Returned if the request is successful.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"automaticRefreshMs\": \"\",\n \"description\": \"\",\n \"editPermissions\": [\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n }\n ],\n \"id\": \"\",\n \"isFavourite\": \"\",\n \"isWritable\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"description\": \"The owner of the dashboard.\",\n \"readOnly\": true,\n \"value\": \"reference #/components/schemas/UserBean not found in the OpenAPI spec\"\n },\n \"popularity\": \"\",\n \"rank\": \"\",\n \"self\": \"\",\n \"sharePermissions\": [\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n }\n ],\n \"systemDashboard\": \"\",\n \"view\": \"\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-51e37142-7094-4ef4-9a60-5b76e0e17740"
},
{
"id": "61b1ee44-957c-498c-9b14-6c372ff67236",
"name": "400 response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-61b1ee44-957c-498c-9b14-6c372ff67236"
},
{
"id": "60b75b46-278b-4f55-ad44-6f472338b137",
"name": "Returned if the authentication credentials are incorrect or missing.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-60b75b46-278b-4f55-ad44-6f472338b137"
},
{
"id": "d19d9c81-d1d3-47d0-a9a7-7135655a4c5b",
"name": "Returned if the dashboard is not found or the dashboard is not owned by or shared with the user.",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"responseTime": null,
"body": null,
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-d19d9c81-d1d3-47d0-a9a7-7135655a4c5b"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-d03ba6f7-cacf-4ad2-b2c5-0f015997b43b"
},
{
"name": "Atlassian Update Dashboard",
"id": "b1379cb8-90c6-4217-bddf-827c0d160009",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardDetails not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"id": "33b3e6e7-4e66-4824-836a-0d7abd656a1c",
"key": "id",
"value": "",
"description": "(Required) The ID of the dashboard to update."
}
]
},
"description": "Updates a dashboard, replacing all the dashboard details with those provided.
**[Permissions](#permissions) required:** None
The dashboard to be updated must be owned by the user."
},
"response": [
{
"id": "5addd6fb-fa55-4c22-b9af-113df0f58743",
"name": "Returned if the request is successful.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardDetails not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"automaticRefreshMs\": \"\",\n \"description\": \"\",\n \"editPermissions\": [\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n }\n ],\n \"id\": \"\",\n \"isFavourite\": \"\",\n \"isWritable\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"description\": \"The owner of the dashboard.\",\n \"readOnly\": true,\n \"value\": \"reference #/components/schemas/UserBean not found in the OpenAPI spec\"\n },\n \"popularity\": \"\",\n \"rank\": \"\",\n \"self\": \"\",\n \"sharePermissions\": [\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/SharePermission not found in the OpenAPI spec\"\n }\n ],\n \"systemDashboard\": \"\",\n \"view\": \"\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-5addd6fb-fa55-4c22-b9af-113df0f58743"
},
{
"id": "31ede47c-c514-4153-b10a-89b1374ad7cc",
"name": "Returned if the request is not valid.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardDetails not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-31ede47c-c514-4153-b10a-89b1374ad7cc"
},
{
"id": "4817a99e-c44a-4911-bd37-0593c32d6779",
"name": "Returned if the authentication credentials are incorrect or missing.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardDetails not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-4817a99e-c44a-4911-bd37-0593c32d6779"
},
{
"id": "ba2e1b20-65cb-4d45-90a3-9bc9d78ce743",
"name": "Returned if the dashboard is not found or the dashboard is not owned by the user.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"reference #/components/schemas/DashboardDetails not found in the OpenAPI spec\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/rest/api/3/dashboard/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"rest",
"api",
"3",
"dashboard",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"responseTime": null,
"body": "{\n \"value\": \"reference #/components/schemas/ErrorCollection not found in the OpenAPI spec\"\n}",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-ba2e1b20-65cb-4d45-90a3-9bc9d78ce743"
}
],
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-b1379cb8-90c6-4217-bddf-827c0d160009"
}
],
"id": "9f8436cf-3bab-436b-abfc-af179870cc5c",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-9f8436cf-3bab-436b-abfc-af179870cc5c"
}
],
"id": "004d5381-945f-46e8-87dd-8ff2318f27b5",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-004d5381-945f-46e8-87dd-8ff2318f27b5"
}
],
"id": "3dda390e-a97b-479e-820b-4305a649cf42",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-3dda390e-a97b-479e-820b-4305a649cf42"
}
],
"id": "b971028d-380c-4641-af03-ca07b6b66eea",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-b971028d-380c-4641-af03-ca07b6b66eea"
}
],
"id": "581ef6c3-ff0b-4325-adcb-8b70741b8e29",
"createdAt": "2026-06-05T15:07:15.000Z",
"updatedAt": "2026-06-05T15:07:15.000Z",
"uid": "35240-581ef6c3-ff0b-4325-adcb-8b70741b8e29"
}
],
"variable": [
{
"key": "baseUrl",
"value": "https://your-domain.atlassian.net"
}
]
}