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

Запрос позволяет создать доску задач: Что такое доска задач.

POST

https://api.tracker.yandex.net/v3/liveBoards/

Ранее для создания доски использовался метод POST /v3/boards/, он устарел. При обращении к этому методу создается доска с параметрами по умолчанию, а параметры из тела запроса игнорируются.

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

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

Чтобы создать доску, используйте HTTP-запрос с методом POST. В теле запроса укажите параметры в формате JSON.

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

{
 "name": "My board",
 "owner": "username",
 "columns": [
    {
      "name": "To Do",
      "statuses": ["new", "open"]
    },
    {
      "name": "In Progress",
      "statuses": ["inProgress"]
    }
  ]
}
Заголовки

  • 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.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Параметры тела запроса

Тело запроса содержит параметры новой доски.

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

Параметр Описание Тип данных
name Название доски Строка

Дополнительные параметры

Параметр

Описание

Тип данных

owner

Логин или uid пользователя

Строка или число

boardPermissionsTemplate

Параметр задает права доступа к доске:

  • private — дока доступна только владельцу;
  • public — доска доступна всем сотрудникам.

По умолчанию доска доступна всем сотрудникам

Строка

backlogAvailable
sprintsAvailable

Опции для включения бэклога и спринтов на доске задач:

  • Если оба параметра одновременно имеют значение true, бэклог и спринты включены
  • Если оба параметра одновременно имеют значение false, бэклог и спринты отключены

Что такое бэклог и спринты

Логический

columns

Перечисление колонок доски

Массив объектов

backlogColumns

Перечисление дополнительных колонок в бэклоге. Что такое колонки в бэклоге

Массив объектов

nonParametrizedColumns

Перечисление произвольных колонок, не привязанных к статусам задач. Что такое произвольные колонки

Массив объектов

autoFilters

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

Объект

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

Параметр Описание Тип данных
name Название колонки Строка
statuses Список статусов, задачи которых отображаются в колонке
Имена и ключи статусов можно посмотреть на странице Настройки Трекера		 Массив строк или чисел
limit Предельное количество задач в колонке Число

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

Параметр Описание Тип данных
name Название колонки в бэклоге Строка
limit Предельное количество задач в колонке Число

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

Параметр Описание Тип данных
name Название колонки Строка
limit Предельное количество задач в колонке Число

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

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

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

Параметр

Описание

Тип данных

liveFilter

Содержит вложенный объект fieldValues, в котором перечислены параметры задач и их значения для фильтрации в формате:

"ключ_параметра": [
   {"fixed": "значение_1"},
   {"fixed": "значение_2"},
   ...
]

Список существующих параметров можно посмотреть на странице Настройки Трекера.

Пример:

"liveFilter": {
  "fieldValues": {
    "queue": [
      {
        "fixed": "DEV"
      }
    ],
    "assignee": [
      {
        "fixed": "username"
      }
    ]
  }
}

Объект

enabled

Если параметр имеет значение true, фильтр включен

Логический

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

Параметр

Описание

Тип данных

statuses

Список статусов, которые будут условием удаления задач с доски.
Имена и ключи статусов можно посмотреть на странице Настройки Трекера

Массив строк

checkResolutionPresence

Параметр указывает, нужно ли учитывать резолюцию при удалении задач:

  • true — удалять только задачи с резолюцией;
  • false — удалять любые задачи

Логический

maxTimeInToRemoveState

Время нахождения в указанных статусах, после которого задачи будут удалены, в формате PnYnMnDTnHnMnS или PnW в соответствии с ISO 8601.

Например, значению P6W соответствует интервал в 6 недель (30 рабочих дней), значению P2M — интервал в 2 месяца.

Строка

enabled

Если параметр имеет значение true, фильтр включен

Логический

Пример 1: Создать доску с настройками:

  • название: Testing,
  • владелец: username,
  • спринты и бэклог включены.
POST /v3/liveBoards/
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
X-Org-ID: <идентификатор_организации>

{
  "name": "Testing",
  "owner": "username",
  "backlogAvailable": true,
  "sprintsAvailable": true
}

Пример 2: Создать доску с настройками:

  • название: Testing,
  • включен фильтр для автоматического добавления задач по параметрам: очередь с ключом DEV, исполнитель с логином username.
POST /v3/liveBoards/
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
X-Org-ID: <идентификатор_организации>

{
 "name": "Testing",
 "autoFilters": {
   "addFilter": {
     "liveFilter": {
       "fieldValues": {
         "queue": [
           {
             "fixed": "DEV"
           }
         ],
         "assignee": [
           {
             "fixed": "username"
           }
         ]
       }
     },
     "enabled": true
   }
 }
}

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

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

Тело ответа содержит 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
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
422
Ошибка валидации JSON, запрос отклонен.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.
Предыдущая
Получить параметры доски
Следующая
Редактировать доску