Получить список эпиков tasks.api.scrum.epic.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
taskКто может выполнять метод: любой пользователь
Метод возвращает список эпиков. В список попадают только эпики тех групп, в которых состоит пользователь.
Параметры метода
В filter, select и order передавайте имена полей эпика в верхнем регистре:
|
Поле ответа |
Имя в |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Внимание
Если в filter передать поле в другом регистре, например groupId, или несуществующее поле, метод вернет пустой массив без ошибки. Так же метод отвечает на несуществующее поле в select и order.
Поля, которых нет в select, метод все равно вернет, но со значением 0 или пустой строкой. Не принимайте такие значения за данные эпика
|
Название |
Описание |
|
order |
Объект для сортировки результата вида Направление сортировки может принимать значения:
|
|
filter |
Объект вида Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
Если префикса нет, а значение содержит символ |
|
select |
Массив полей, которые нужно заполнить в ответе, например |
|
start |
Смещение выборки, кратное 50, по умолчанию Формула расчета: |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"filter": {
"GROUP_ID": 143,
">=ID": 1,
"<=ID": 50,
"NAME": "%эпик%",
"!=DESCRIPTION": "old epic"
},
"order": {
"ID": "asc",
"NAME": "desc"
},
"select": ["ID", "NAME", "DESCRIPTION", "CREATED_BY", "MODIFIED_BY", "COLOR"],
"start": 0
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.epic.list
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"filter": {
"GROUP_ID": 143,
">=ID": 1,
"<=ID": 50,
"NAME": "%эпик%",
"!=DESCRIPTION": "old epic",
"CREATED_BY": 1,
"MODIFIED_BY": 3,
"COLOR": "#69dafc"
},
"order": {
"ID": "asc",
"NAME": "desc"
},
"select": ["ID", "NAME", "DESCRIPTION", "CREATED_BY", "MODIFIED_BY", "COLOR"],
"start": 0,
"auth": "YOUR_ACCESS_TOKEN"
}' \
https://your-domain.bitrix24.com/rest/tasks.api.scrum.epic.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each EpicItem returned in result[]
type EpicItem = {
id: number
groupId: number
name: string
description: string
createdBy: number
modifiedBy: number
color: string
}
try {
// tasks.api.scrum.epic.list returns a single page (max 50 records) without `total` and `next`.
// To load the next page, repeat the call with `start` increased by 50.
const response = await $b24.actions.v2.call.make<EpicItem[]>({
method: 'tasks.api.scrum.epic.list',
params: {
filter: {
GROUP_ID: 143,
'>=ID': 1,
'<=ID': 50,
NAME: '%epic%',
'!=DESCRIPTION': 'old epic',
CREATED_BY: 1,
MODIFIED_BY: 3,
COLOR: '#69dafc',
},
order: {
ID: 'asc',
NAME: 'desc',
},
select: ['ID', 'NAME', 'DESCRIPTION', 'CREATED_BY', 'MODIFIED_BY', 'COLOR'],
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Loaded epics:', result.length, result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function loadEpicList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// tasks.api.scrum.epic.list returns a single page (max 50 records) without `total` and `next`.
// To load the next page, repeat the call with `start` increased by 50.
const response = await $b24.actions.v2.call.make({
method: 'tasks.api.scrum.epic.list',
params: {
filter: {
GROUP_ID: 143,
'>=ID': 1,
'<=ID': 50,
NAME: '%epic%',
'!=DESCRIPTION': 'old epic',
CREATED_BY: 1,
MODIFIED_BY: 3,
COLOR: '#69dafc',
},
order: {
ID: 'asc',
NAME: 'desc',
},
select: ['ID', 'NAME', 'DESCRIPTION', 'CREATED_BY', 'MODIFIED_BY', 'COLOR'],
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Loaded epics:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', loadEpicList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.epic.list(
filter={
"GROUP_ID": 143,
">=ID": 1,
"<=ID": 50,
"NAME": "%epic%",
"!=DESCRIPTION": "old epic",
"CREATED_BY": 1,
"MODIFIED_BY": 3,
"COLOR": "#69dafc",
},
order={
"ID": "asc",
"NAME": "desc",
},
select=[
"ID",
"NAME",
"DESCRIPTION",
"CREATED_BY",
"MODIFIED_BY",
"COLOR",
],
start=0,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
Пример as_list
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.epic.list(
filter={
"GROUP_ID": 143,
">=ID": 1,
"<=ID": 50,
"NAME": "%epic%",
"!=DESCRIPTION": "old epic",
"CREATED_BY": 1,
"MODIFIED_BY": 3,
"COLOR": "#69dafc",
},
order={
"ID": "asc",
"NAME": "desc",
},
select=[
"ID",
"NAME",
"DESCRIPTION",
"CREATED_BY",
"MODIFIED_BY",
"COLOR",
],
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
Пример as_list_fast
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.epic.list(
filter={
"GROUP_ID": 143,
">=ID": 1,
"<=ID": 50,
"NAME": "%epic%",
"!=DESCRIPTION": "old epic",
"CREATED_BY": 1,
"MODIFIED_BY": 3,
"COLOR": "#69dafc",
},
order={
"ID": "asc",
"NAME": "desc",
},
select=[
"ID",
"NAME",
"DESCRIPTION",
"CREATED_BY",
"MODIFIED_BY",
"COLOR",
],
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'tasks.api.scrum.epic.list',
[
'filter' => [
'GROUP_ID' => $groupId,
'>=ID' => 1,
'<=ID' => 50,
'NAME' => '%эпик%',
'!=DESCRIPTION' => 'old epic',
'CREATED_BY' => 1,
'MODIFIED_BY' => 3,
'COLOR' => '#69dafc'
],
'order' => [
'ID' => 'asc',
'NAME' => 'desc'
],
'select' => ['ID', 'NAME', 'DESCRIPTION', 'CREATED_BY', 'MODIFIED_BY', 'COLOR'],
'start' => 0
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
const groupId = 143;
BX24.callMethod(
'tasks.api.scrum.epic.list',
{
filter: {
GROUP_ID: groupId,
'>=ID': 1,
'<=ID': 50,
'NAME': '%эпик%',
'!=DESCRIPTION': 'old epic',
'CREATED_BY': 1,
'MODIFIED_BY': 3,
'COLOR': '#69dafc'
},
order: {
'ID': 'asc',
'NAME': 'desc'
},
select: ['ID', 'NAME', 'DESCRIPTION', 'CREATED_BY', 'MODIFIED_BY', 'COLOR']
},
function(res)
{
if (res.error())
{
console.error(res.error());
return;
}
console.log(res.data());
}
);
require_once('crest.php'); // подключение CRest PHP SDK
// выполнение запроса к REST API
$result = CRest::call(
'tasks.api.scrum.epic.list',
[
'filter' => [
'GROUP_ID' => 143,
'>=ID' => 1,
'<=ID' => 50,
'NAME' => '%эпик%',
'!=DESCRIPTION' => 'old epic',
'CREATED_BY' => 1,
'MODIFIED_BY' => 3,
'COLOR' => '#69dafc'
],
'order' => [
'ID' => 'asc',
'NAME' => 'desc'
],
'select' => ['ID', 'NAME', 'DESCRIPTION', 'CREATED_BY', 'MODIFIED_BY', 'COLOR'],
'start' => 0
]
);
// Обработка ответа от Битрикс24
if ($result['error']) {
echo 'Error: '.$result['error_description'];
}
else {
print_r($result['result']);
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.api.scrum.epic.list", b24.Params{
"filter": b24.Params{
"GROUP_ID": 143,
">=ID": 1,
"<=ID": 50,
"NAME": "%эпик%",
"!=DESCRIPTION": "old epic",
"CREATED_BY": 1,
"MODIFIED_BY": 3,
"COLOR": "#69dafc",
},
"order": b24.Params{
"ID": "asc",
"NAME": "desc",
},
"select": []string{"ID", "NAME", "DESCRIPTION", "CREATED_BY", "MODIFIED_BY", "COLOR"},
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("tasks.api.scrum.epic.list: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"id": 12,
"groupId": 0,
"name": "Новый эпик",
"description": "",
"createdBy": 1,
"modifiedBy": 3,
"color": "#69dafc"
}
],
"time": {
"start": 1790263004,
"finish": 1790263004.141055,
"duration": 0.14105510711669922,
"processing": 0,
"date_start": "2026-09-24T18:16:44+03:00",
"date_finish": "2026-09-24T18:16:44+03:00",
"operating_reset_at": 1790263604,
"operating": 0
}
}
В примере groupId равен 0, потому что поля GROUP_ID нет в select запроса. Если эпиков по условиям нет, result — пустой массив. Полей total и next в ответе нет.
Возвращаемые данные
|
Название |
Описание |
|
result |
Массив эпиков (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Объект эпика
|
Название |
Описание |
|
id |
Идентификатор эпика |
|
groupId |
Идентификатор Скрама, к которому относится эпик |
|
name |
Название эпика |
|
description |
Описание эпика |
|
createdBy |
Идентификатор пользователя, создавшего эпик |
|
modifiedBy |
Идентификатор пользователя, который последним изменил эпик. Если эпик не меняли — |
|
color |
Цвет эпика |
Прикрепленные файлы метод не возвращает. Получить их можно методом tasks.api.scrum.epic.get.
Обработка ошибок
У метода нет своих ошибок. Пример общей ошибки — токен приложения без scope task:
HTTP-статус: 401
{
"error": "insufficient_scope",
"error_description": "The request requires higher privileges than provided by the access token"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Эпики в Скраме: обзор методов
- Добавить эпик в Скрам tasks.api.scrum.epic.add
- Обновить эпик в Скраме tasks.api.scrum.epic.update
- Получить поля эпика по его идентификатору tasks.api.scrum.epic.get
- Удалить эпик tasks.api.scrum.epic.delete
- Получить список доступных полей эпика tasks.api.scrum.epic.getFields