Получить параметры доски задач

Запрос позволяет получить параметры доски задач.

GET

https://api.tracker.yandex.net/v3/boards/<id_доски>

Формат запроса

Перед выполнением запроса получите доступ к API.

Чтобы получить параметры конкретной доски задач, используйте HTTP-запрос с методом GET.

GET /v3/boards/<id_доски>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

Заголовки

Host: адрес узла, предоставляющего API.
Authorization: токен для авторизации в одном из форматов:
- OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее
- Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее
X-Org-ID или X-Cloud-Org-ID: идентификатор организации.
- если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,
- если к Трекеру привязана организация Yandex Cloud Organization, используйте заголовок X-Cloud-Org-ID.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс

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

Формат ответа

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

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

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело ответа содержит JSON-объект с параметрами доски.

{
    "self": "https://api.tracker.yandex.net/v3/boards/1",
    "id": 1,
    "version": 1,
    "name": "My board",
    "createdAt": "2026-01-22T09:02:18.647+0000",
    "updatedAt": "2026-01-22T09:02:18.647+0000",
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v3/users/112000***",
        "id": "username",
        "display": "Имя Фамилия",
        "cloudUid": "ajevuhegoggfk*******",
        "passportUid": 112000***
    },
    "columns": [
      {
        "self": "https://api.tracker.yandex.net/v3/boards/1/columns/1",
        "id": "1",
        "display": "Открыт"
      },
      ...
    ],
    "useRanking": false,
    "estimateBy": {
        "self": "https://api.tracker.yandex.net/v3/fields/storyPoints",
        "id": "storyPoints",
        "display": "Story Points"
    },
    "country": {
        "self": "https://api.tracker.yandex.net/v3/countries/1",
        "id": "1",
        "display": "Россия"
    },
    "calendar": {
        "id": 6
    }
}

Параметры ответа

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит параметры доски	Строка
id	Идентификатор доски	Число
version	Версия доски. Каждое изменение доски увеличивает номер версии	Число
name	Название доски	Строка
createdAt	Дата создания доски в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm`	Строка
updatedAt	Дата последнего обновления доски в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm`	Строка
createdBy	Блок с информацией о пользователе, создавшем доску	Объект
columns	Блок с информацией о колонках доски	Массив объектов
useRanking	Параметр устарел и не влияет на работу доски Возможность менять порядок задач на доске: `true`— разрешено; `false`— запрещено.	Логический
estimateBy	Параметр устарел и не влияет на работу доски Блок с информацией о поле задачи, которое используется для оценки трудоемкости	Объект
country	Параметр устарел и не влияет на работу доски Блок с информацией о стране	Объект
calendar	Объект, который содержит идентификатор календаря. Данные календаря используются в диаграмме сгорания задач.	Объект
autoFilterSettings	Блок с информацией о настройках фильтров, с помощью которых задачи автоматически добавляются на доску и удаляются с доски	Объект

Поля объекта createdBy

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о пользователе.	Строка
id	Идентификатор пользователя.	Строка
display	Отображаемое имя пользователя.	Строка
passportUid	Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID.	Число
cloudUid	Уникальный идентификатор пользователя в Yandex Cloud Organization.	Строка

Поля объекта columns

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

Поля объекта autoFilterSettings

Параметр	Описание	Тип данных
addFilterSettings	Объект с настройками фильтра для автоматического добавления задач на доску	Объект
removeFilterSettings	Объект с настройками фильтра для автоматического удаления задач с доски	Объект

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

400: Один или несколько параметров запроса имеют недопустимое значение.

403: У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.

404: Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.

500: Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

503: Сервис API временно недоступен.

Была ли статья полезна?

Получить параметры всех досок с поддержкой пагинации

Создать доску