---
metadata:
  - name: generator
    content: Diplodoc Platform v5.57.3
  - property: og:type
    content: article
  - property: article:section
    content: Справочник API
  - property: og:title
    content: Получить параметры фильтра
  - property: article:tag
    content: Техническая инструкция
alternate:
  - https://yandex.ru/support/tracker/en/api/filters/get-filter.md
  - https://yandex.ru/support/tracker/ru/api/filters/get-filter.md
  - href: ru/api/filters/get-filter.md
    type: text/markdown
    title: Markdown version
  - href: ../../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/ru/llms.txt


# Получить параметры фильтра

Запрос позволяет получить информацию о фильтре задач.

<div class="request_example yfm-code-floating-container method_get">
    <p>GET</p>
    <pre><code>https://api.tracker.yandex.net/v3/filters/&lt;id_фильтра></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: ru/api/_assets/style/methods.md -->

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

## Формат запроса {#query}

Перед выполнением запроса [получите доступ к API](https://yandex.ru/support/tracker/ru/api/access.md).

Для получения фильтра используйте HTTP-запрос с методом `GET`:

```json translate=no
GET /v3/filters/<id_фильтра>
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
```

<!-- source: ru/api/_includes/headings-no-body.md -->
{% cut "Заголовки" %}

* `Host`: адрес узла, предоставляющего API.

* <!-- source: ru/api/_includes/authorization.md -->
  `Authorization`: токен для авторизации в одном из форматов:

    - `OAuth <OAuth-токен>` при авторизации по протоколу OAuth 2.0. [Читать подробнее](https://yandex.ru/support/tracker/ru/api/access.md#about_OAuth)

    - `Bearer <IAM-токен>` при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. [Читать подробнее](https://yandex.ru/support/tracker/ru/api/access.md#iam-token)
  <!-- endsource: ru/api/_includes/authorization.md -->


* <!-- source: ru/api/_includes/org-id.md -->
  `X-Org-ID` или `X-Cloud-Org-ID`: идентификатор организации.

  - если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок `X-Org-ID`,

  - если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок `X-Cloud-Org-ID`.
  <!-- endsource: ru/api/_includes/org-id.md -->

  <!-- source: ru/api/_includes/org-id.md -->
  Чтобы узнать идентификатор организации, перейдите на страницу **Администрирование** → [**Организации**](https://tracker.yandex.ru/admin/orgs) и скопируйте значение поля **идентификатор**.
  <!-- endsource: ru/api/_includes/org-id.md -->


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

{% cut "Параметры запроса" %}

**Обязательные параметры**

Параметр | Описание | Тип данных
----- | ----- | -----
\<id_фильтра\> | Идентификатор фильтра. | Число

{% endcut %}

> Пример: Получить параметры фильтра
>
> - Используется HTTP-метод GET.
> - Запрашивается фильтр с идентификатором 12345.
>
> ```
> GET /v3/filters/12345 HTTP/1.1
> Host: api.tracker.yandex.net
> Authorization: OAuth y0__xAbc******
> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
> ```

## Формат ответа {#answer}

{% list tabs %}

- Запрос выполнен успешно

    <!-- source: ru/api/_includes/answer-200.md -->
    В случае успешного выполнения запроса API возвращает ответ с кодом `200 OK`.
    <!-- endsource: ru/api/_includes/answer-200.md -->

    Тело ответа содержит информацию о фильтре в формате JSON.

    ```json
    {
        "id": 12345,
        "self": "https://api.tracker.yandex.net/v3/filters/12345",
        "name": "Мои открытые задачи",
        "filter": {
            "assignee": "me()",
            "status": "open"
        },
        "fields": [
            {
                "self": "https://api.tracker.yandex.net/v3/fields/key",
                "id": "key",
                "display": "Ключ"
            },
            {
                "self": "https://api.tracker.yandex.net/v3/fields/summary",
                "id": "summary",
                "display": "Задача"
            },
            {
                "self": "https://api.tracker.yandex.net/v3/fields/status",
                "id": "status",
                "display": "Статус"
            }
        ],
        "groupBy": {
        "self": "https://api.tracker.yandex.net/v3/fields/status",
        "id": "status",
        "display": "Статус"
        },
        "favorite": false,
        "permissions": {
            "READ": {
                "users": [],
                "groups": [
                    {
                        "self": "https://api.tracker.yandex.net/v3/groups/5",
                        "id": "5",
                        "display": "Все сотрудники"
                    }
                ],
                "roles": []
            },
            "WRITE": {
                "users": [
                    {
                        "self": "https://api.tracker.yandex.net/v3/users/1234567890",
                        "id": "1234567890",
                        "display": "Имя Фамилия",
                        "cloudUid": "ajevuhegoiuhfasjhiu",
                        "passportUid": 1234567890
                    }
                ],
                "groups": [],
                "roles": []
            }
        },
        "owner": {
            "self": "https://api.tracker.yandex.net/v3/users/1234567890",
            "id": "1234567890",
            "display": "Имя Фамилия",
            "cloudUid": "ajevuhegoiuhfasjhiu",
            "passportUid": 1234567890
        }
    }
    ```

    {% cut "Параметры ответа" %}

    Параметр | Описание | Тип данных
    ----- | ----- | -----
    id | Идентификатор фильтра. | Число
    self | Адрес ресурса API, который содержит информацию о фильтре. | Строка
    name | Название фильтра. | Строка
    [filter](#filter) | Объект с условиями фильтрации. | Объект
    query | Строка с условиями фильтрации, записанными на языке запросов. | Строка
    [fields](#fields) | Массив полей задачи для отображения в UI. | Массив объектов
    [groupBy](#groupBy) | Поле для группировки результатов в UI. | Объект
    favorite | Признак избранного фильтра: `true` — фильтр добавлен в избранное, `false` — не добавлен. | Логический
    [permissions](#permissions) | Объект с информацией о правах доступа к фильтру. | Объект
    [owner](#owner) | Объект с информацией о владельце фильтра. | Объект

    **Поля массива** `fields` {#fields}

    Массив содержит объекты с информацией о полях задачи, которые будут отображаться в пользовательском интерфейсе Tracker при использовании фильтра.

    Параметр | Описание | Тип данных
    ----- | ----- | -----
    self | Адрес ресурса API, который содержит информацию о поле. | Строка
    id | Идентификатор поля. | Строка
    display | Отображаемое название поля. | Строка

    **Пример:**
    ```json
    "fields": [
        {
            "self": "https://api.tracker.yandex.net/v3/fields/key",
            "id": "key",
            "display": "Ключ"
        },
        {
            "self": "https://api.tracker.yandex.net/v3/fields/summary",
            "id": "summary",
            "display": "Название"
        }
    ]
    ```

    {% note info %}

    Параметр `fields` влияет только на отображение в интерфейсе Tracker, но не влияет на результаты API-запросов. При использовании фильтра через API (метод `/v2/issues/_search`) будут возвращаться все поля задачи независимо от значения параметра `fields`.

    {% endnote %}

    **Поля объекта** `groupBy` {#groupBy}

    Объект содержит информацию о поле, по которому группируются результаты в пользовательском интерфейсе Tracker.

    Параметр | Описание | Тип данных
    ----- | ----- | -----
    self | Адрес ресурса API, который содержит информацию о поле. | Строка
    id | Идентификатор поля. | Строка
    display | Отображаемое название поля. | Строка

    **Пример:**
    ```json
    "groupBy": {
        "self": "https://api.tracker.yandex.net/v3/fields/status",
        "id": "status",
        "display": "Статус"
    }
    ```

    {% note info %}

    Параметр `groupBy` влияет только на отображение в интерфейсе Tracker (задачи группируются по указанному полю), но не изменяет результаты API-запросов.

    {% endnote %}

    **Поля объекта** `permissions` {#permissions}

    Параметр | Описание | Тип данных
    ----- | ----- | -----
    [READ](#permission-item) | Объект с информацией о правах на чтение фильтра. | Объект
    [WRITE](#permission-item) | Объект с информацией о правах на редактирование фильтра. | Объект

    **Поля объектов** `READ` и `WRITE` {#permission-item}

    Параметр | Описание | Тип данных
    ----- | ----- | -----
    users | Массив пользователей, у которых есть соответствующие права. | Массив объектов
    groups | Массив групп, у которых есть соответствующие права. | Массив объектов
    roles | Массив ролей, у которых есть соответствующие права. | Массив объектов

    **Поля объекта** `owner` {#owner}

    <!-- source: ru/api/_includes/user.md -->
    Параметр | Описание | Тип данных
    ----- | ----- | -----
    self | Адрес ресурса API, который содержит информацию о пользователе. | Строка
    id | Идентификатор пользователя. | Строка
    display | Отображаемое имя пользователя. | Строка
    passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число
    cloudUid | Уникальный идентификатор пользователя в Yandex Identity Hub. | Строка
    <!-- endsource: ru/api/_includes/user.md -->

    {% endcut %}

- Запрос выполнен с ошибкой

    Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

    <!-- source: ru/api/_includes/answer-error-401.md -->
    401
    :   Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе [Доступ к API](https://yandex.ru/support/tracker/ru/api/access.md).
    <!-- endsource: ru/api/_includes/answer-error-401.md -->

    <!-- source: ru/api/_includes/answer-error-403.md -->
    403
    :   У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
    <!-- endsource: ru/api/_includes/answer-error-403.md -->

    <!-- source: ru/api/_includes/answer-error-404.md -->
    404
    :   Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
    <!-- endsource: ru/api/_includes/answer-error-404.md -->

{% endlist %}