---
metadata:
  - name: generator
    content: Diplodoc Platform v5.64.0
  - property: og:type
    content: article
  - property: article:section
    content: API reference
  - property: og:title
    content: Getting dashboard permissions
alternate:
  - https://yandex.com.tr/support/tracker/en/api/dashboards/get-dashboard-permissions.md
  - href: https://yandex.com.tr/support/tracker/en/api/dashboards/get-dashboard-permissions.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.com.tr/support/tracker/en/llms.txt?revision=r21825371
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/support/tracker/en/llms.txt?revision=r21825371


# Getting dashboard permissions

Use this request to get effective dashboard permissions. You need the `GRANT` permission for the dashboard.

<div class="request_example yfm-code-floating-container method_get">
    <p>GET</p>
    <pre><code>https://api.tracker.yandex.net/v3/dashboards/{dashboard_ID}/permissions</code></pre>
    <button class="yfm-clipboard-button"><svg width="16" height="16" viewBox="0 0 24 24" class="yfm-clipboard-icon" data-animation="15">
    <path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path>
    <path stroke="currentColor" fill="transparent" strokewidth="1.5" d="M9.5 13l3 3l5 -5" visibility="hidden">
        <animate id="visibileAnimation-15" attributeName="visibility" from="hidden" to="visible" dur="0.2s" fill="freeze" begin=""></animate>
        <animate id="hideAnimation-15" attributeName="visibility" from="visible" to="hidden" dur="1s" begin="visibileAnimation-15.end+1" fill="freeze"></animate>
    </path>
</svg>
</button>
</div>

<!-- source: en/api/_assets/style/methods.md -->

<!-- endsource: en/api/_assets/style/methods.md -->

## Request format {#request}

Before making a request, [get permission to access the API](https://yandex.com.tr/support/tracker/en/api/access.md).

```json translate=no
GET /v3/dashboards/{dashboard_ID}/permissions
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID or X-Cloud-Org-ID: ORGANIZATION_ID
```

<!-- source: en/api/_includes/headings-no-body.md -->
{% cut "Headers" %}

* `Host`: address of the node that provides the API.

* <!-- source: en/api/_includes/authorization.md -->
  `Authorization`: Authorization token about these formats:

    - `OAuth OAUTH_TOKEN`: For authorization using the OAuth 2.0 protocol. [Learn more](https://yandex.com.tr/support/tracker/en/api/access.md#about_OAuth)

    - `Bearer IAM_TOKEN`: For authorization using an IAM token, if a Yandex Identity Hub organization is linked to Tracker. [Learn more](https://yandex.com.tr/support/tracker/en/api/access.md#iam-token)
  <!-- endsource: en/api/_includes/authorization.md -->


* <!-- source: en/api/_includes/org-id.md -->
  # ID types {#types}


  `X-Org-ID` or `X-Cloud-Org-ID`: Organization ID.

  - Use the `X-Org-ID` header if a Tracker organization is linked to Yandex 360 for Business.

  - Use the `X-Cloud-Org-ID` header if a Tracker organization is linked to Yandex Identity Hub.


  # Finding the ID {#find-id}


  To get the organization ID, go to **Administration** → [**Organizations**](https://tracker.yandex.com/admin/orgs) and copy the value from the **ID** field.
  <!-- endsource: en/api/_includes/org-id.md -->


{% endcut %}
<!-- endsource: en/api/_includes/headings-no-body.md -->

{% cut "Resource" %}

#|
|| **Parameter** | **Description** | **Data type** ||
|| dashboard_ID | Dashboard ID. | Number ||
|#

{% endcut %}

## Response format {#response}

{% list tabs %}

- Request executed successfully

    <!-- source: en/api/_includes/answer-200.md -->
    If the request is successful, the API returns a response with code `200 OK`.
    <!-- endsource: en/api/_includes/answer-200.md -->

    The API returns an object with the effective dashboard permissions.

    ```json translate=no
    {
      "acl": {
        "READ": {
          "users": [],
          "groups": [
            {
              "self": "https://api.tracker.yandex.net/v3/groups/3",
              "id": "3",
              "display": "All employees"
            }
          ],
          "roles": []
        },
        "WRITE": {
          "users": [
            {
              "self": "https://api.tracker.yandex.net/v3/users/1234567890",
              "id": "1234567890",
              "display": "User"
            }
          ],
          "groups": [],
          "roles": [
            {
              "id": "OWNER",
              "name": "Owner"
            }
          ]
        },
        "GRANT": {
          "users": [],
          "groups": [],
          "roles": [
            {
              "id": "OWNER",
              "name": "Owner"
            }
          ]
        }
      }
    }
    ```

    {% cut "Response parameters" %}

    #|
    || **Parameter** | **Description** | **Data type** ||
    || acl | Effective permissions. | Object ||
    || inheritedFrom | Source of inherited permissions. Omitted when permissions are set directly on the dashboard. | Object ||
    |#

    **Fields of the** `acl` **object**

    #|
    || **Parameter** | **Description** | **Data type** ||
    || READ | Subjects with read access. | Object ||
    || WRITE | Subjects with write access. Also grants `READ`. | Object ||
    || GRANT | Subjects who can manage access. | Object ||
    |#

    **Fields of the** `READ`, `WRITE`, **and** `GRANT` **objects**

    #|
    || **Parameter** | **Description** | **Data type** ||
    || users | User references. [User object fields](https://yandex.com.tr/support/tracker/en/api/dashboards/create-dashboard.md#user). | Array of objects ||
    || groups | Group references with `self`, `id`, and `display` fields. | Array of objects ||
    || roles | System roles with `id` and `name` fields. | Array of objects ||
    |#


    **Fields of elements in the** `groups` **array**

    #|
    || **Parameter** | **Description** | **Data type** ||
    || self | Group API resource URL. | String ||
    || id | Group ID. | String ||
    || display | Group name. | String ||
    |#

    **Fields of elements in the** `roles` **array**

    #|
    || **Parameter** | **Description** | **Data type** ||
    || id | System role ID, for example `OWNER`. | String ||
    || name | Role name. | String ||
    |#

    {% endcut %}

- Request failed

    If the request is processed incorrectly, the API returns a response with an error code:

    <!-- source: en/api/_includes/answer-error-403.md -->
    403
    :   You are not authorized to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
    <!-- endsource: en/api/_includes/answer-error-403.md -->

    No `GRANT` permission for the dashboard.

    <!-- source: en/api/_includes/answer-error-404.md -->
    404
    :   The requested object was not found. You may have specified an invalid object ID or key.
    <!-- endsource: en/api/_includes/answer-error-404.md -->

{% endlist %}