Get a List of Epics tasks.api.scrum.epic.list
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the MCP server so that the assistant can utilize the official REST documentation.
Scope:
taskWho can execute the method: any user
This method returns a list of epics.
Method Parameters
|
Name |
Description |
|
order |
An array for sorting the result in the format The sort direction can take the following values:
Possible values for the array elements correspond to the fields in the response of tasks.api.scrum.epic.add |
|
filter |
An array in the format An additional prefix can be specified for the key to clarify the filter behavior. Possible prefix values:
Possible values for the array elements correspond to the fields in the response of tasks.api.scrum.epic.add |
|
select |
An array of record fields that will be returned by the method. Possible values for the array elements correspond to the fields in the response of tasks.api.scrum.epic.add. You can specify only the fields that are necessary. If the array contains the value The default value is an empty array |
|
start |
The page number of the output. Works for HTTPS requests. The page size of results is always static: 50 records. To select the second page of results, you need to pass the value The formula for calculating the |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"filter": {
"GROUP_ID": 143,
">=ID": 1,
"<=ID": 50,
"NAME": "%epic%",
"!=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": "%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,
"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). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
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). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
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>
try {
$response = $b24Service
->core
->call(
'tasks.api.scrum.epic.list',
[
'filter' => [
'GROUP_ID' => $groupId,
'>=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
]
);
$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': '%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']
},
function(res)
{
if (res.error())
{
console.error(res.error());
return;
}
console.log(res.data());
if (res.more())
{
res.next();
}
}
);
require_once('crest.php'); // connecting CRest PHP SDK
// executing a request to the REST API
$result = CRest::call(
'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
]
);
// Processing the response from Bitrix24
if ($result['error']) {
echo 'Error: '.$result['error_description'];
}
else {
print_r($result['result']);
}
Response Handling
HTTP Status: 200
[
{
"id": 1,
"groupId": 143,
"name": "epic",
"description": "",
"createdBy": 1,
"modifiedBy": 0,
"color": "#69dafc"
},
{
"id": 3,
"groupId": 143,
"name": "epic2",
"description": "new epic",
"createdBy": 3,
"modifiedBy": 5,
"color": "#69dagc"
}
]
Returned Data
|
Name |
Description |
|
id |
Epic identifier |
|
groupId |
Identifier of the group (scrum) to which the epic is linked |
|
name |
Name of the epic |
|
description |
Description of the epic |
|
createdBy |
Identifier of the user who created the epic |
|
modifiedBy |
Identifier of the user who last modified the epic |
|
color |
Color of the epic in HEX format |
Error Handling
HTTP Status: 400
{
"error": 0,
"error_description": "Could not load list"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Could not load list |
No epics found with the specified filters |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |