Получить список рабочих процессов
Запрос позволяет получить список всех рабочих процессов организации.
GET
https://api.tracker.yandex.net/v3/workflows
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы получить список рабочих процессов, используйте HTTP-запрос с методом GET.
GET /v3/workflows
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 Identity Hub. Читать подробнее
-
-
X-Org-IDилиX-Cloud-Org-ID: идентификатор организации.-
если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок
X-Org-ID, -
если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок
X-Cloud-Org-ID.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.
-
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.
Тело ответа содержит массив рабочих процессов в формате JSON. Возвращаются все рабочие процессы организации, кроме удаленных.
Незаполненные необязательные поля API не возвращает в ответе. Например, queue, type, createdBy и updatedBy.
[
{
"self": "https://api.tracker.yandex.net/v3/workflows/W21",
"id": "W21",
"name": "Design",
"version": 1,
"steps": [
{
"status": {
"self": "https://api.tracker.yandex.net/v3/statuses/1",
"id": "1",
"key": "open",
"display": "Открыт"
},
"actions": [
{
"id": "inProgress",
"name": "Взять в работу",
"target": {
"self": "https://api.tracker.yandex.net/v3/statuses/3",
"id": "3",
"key": "inProgress",
"display": "В работе"
}
}
]
},
{
"status": {
"self": "https://api.tracker.yandex.net/v3/statuses/3",
"id": "3",
"key": "inProgress",
"display": "В работе"
},
"actions": [
{
"id": "close",
"name": "Закрыть",
"target": {
"self": "https://api.tracker.yandex.net/v3/statuses/8",
"id": "8",
"key": "closed",
"display": "Закрыт"
}
}
]
},
{
"status": {
"self": "https://api.tracker.yandex.net/v3/statuses/8",
"id": "8",
"key": "closed",
"display": "Закрыт"
}
}
],
"initialAction": {
"id": "open",
"name": "Открыть",
"target": {
"self": "https://api.tracker.yandex.net/v3/statuses/1",
"id": "1",
"key": "open",
"display": "Открыт"
}
},
"queue": {
"self": "https://api.tracker.yandex.net/v3/queues/DESIGN",
"id": "4",
"key": "DESIGN",
"display": "DESIGN"
},
"created": "2026-08-11T14:37:06.356+0000",
"updated": "2026-08-11T14:37:06.356+0000",
"createdBy": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия",
"cloudUid": "ajeppa7dgp53********",
"passportUid": 1100000000
},
"updatedBy": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия",
"cloudUid": "ajeppa7dgp53********",
"passportUid": 1100000000
},
"deleted": false,
"type": "visual"
}
]
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Ссылка на рабочий процесс. | Строка |
| id | Идентификатор рабочего процесса. | Строка |
| name | Название рабочего процесса. | Строка |
| version | Версия рабочего процесса. Каждое изменение увеличивает номер версии. | Число |
| steps | Массив шагов рабочего процесса. | Массив объектов |
| initialAction | Начальное действие. | Объект |
| queue | Очередь, к которой привязан рабочий процесс. | Объект |
| created | Дата и время создания. | Строка |
| updated | Дата и время последнего изменения. | Строка |
| createdBy | Автор рабочего процесса. | Объект |
| updatedBy | Пользователь, последним изменивший рабочий процесс. | Объект |
| deleted | Признак удаленного рабочего процесса. | Логический |
| type | Тип рабочего процесса. Сейчас единственное значение — visual. У созданных ранее рабочих процессов поле может отсутствовать. |
Строка |
Поля объектов массива steps
| Параметр | Описание | Тип данных |
|---|---|---|
| status | Статус шага. | Объект |
| actions | Массив действий (переходов), доступных из этого статуса. | Массив объектов |
Поля объекта status
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Ссылка на статус. | Строка |
| id | Идентификатор статуса. | Строка |
| key | Ключ статуса. | Строка |
| display | Отображаемое название статуса. | Строка |
Поля объектов action и initialAction
| Параметр | Описание | Тип данных |
|---|---|---|
| id | Идентификатор действия. | Строка |
| name | Название действия. | Строка |
| target | Целевой статус, в который переводит действие. | Объект |
Поля объекта target
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Ссылка на статус. | Строка |
| id | Идентификатор статуса. | Строка |
| key | Ключ статуса. | Строка |
| display | Отображаемое название статуса. | Строка |
Поля объекта queue
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Ссылка на очередь. | Строка |
| id | Идентификатор очереди. | Строка |
| key | Ключ очереди. | Строка |
| display | Отображаемое название очереди. | Строка |
Поля объекта пользователя (createdBy, updatedBy)
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Ссылка на пользователя. | Строка |
| id | Идентификатор пользователя. | Строка |
| display | Отображаемое имя пользователя. | Строка |
| cloudUid | Уникальный идентификатор пользователя в Яндекс Облаке. | Строка |
| passportUid | Уникальный идентификатор аккаунта пользователя в Яндекс Паспорте. | Число |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.