Get Epic Fields by Its Identifier tasks.api.scrum.epic.get
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
taskWho can execute the method: any user with access to Scrum
The method retrieves the values of the epic fields by its identifier id.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Epic identifier. You can get the identifiers of epics using the method |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.epic.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.api.scrum.epic.get
// 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 the payload returned in result (match the "response handling" section of the page)
type EpicGetResult = {
id: number
groupId: number
name: string
description: string
createdBy: number
modifiedBy: number
color: string
files: Record<string, unknown>
}
try {
const response = await $b24.actions.v2.call.make<EpicGetResult>({
method: 'tasks.api.scrum.epic.get',
params: {
id: 1,
},
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(result.id, result.name, result.color)
}
} 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 getEpic() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'tasks.api.scrum.epic.get',
params: {
id: 1,
},
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(result.id, result.name, result.color)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getEpic)
</script>
try {
$epicId = 1;
$response = $b24Service
->core
->call(
'tasks.api.scrum.epic.get',
[
'id' => $epicId,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting epic: ' . $e->getMessage();
}
const epicId = 1;
BX24.callMethod(
'tasks.api.scrum.epic.get',
{
id: epicId,
},
function(res)
{
console.log(res);
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.api.scrum.epic.get',
[
'id' => 1
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"id": 1,
"groupId": 143,
"name": "epic",
"description": "",
"createdBy": 1,
"modifiedBy": 0,
"color": "#69dafc",
"files": {
"ID": "136",
"ENTITY_ID": "TASKS_SCRUM_EPIC",
"FIELD_NAME": "UF_SCRUM_EPIC_FILES",
"USER_TYPE_ID": "disk_file",
"XML_ID": null,
"SORT": "100",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "N",
"EDIT_IN_LIST": "N",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"IBLOCK_ID": null,
"SECTION_ID": null,
"UF_TO_SAVE_ALLOW_EDIT": false
},
"USER_TYPE": {
"USER_TYPE_ID": "disk_file",
"CLASS_NAME": "Bitrix\\Disk\\Uf\\FileUserType",
"DESCRIPTION": "File (Drive)",
"BASE_TYPE": "int",
"TAG": [
"DISK FILE ID",
"DOCUMENT ID"
]
},
"VALUE": [],
"ENTITY_VALUE_ID": 1,
"CUSTOM_DATA": {
"PHOTO_TEMPLATE": ""
},
"EDIT_FORM_LABEL": "UF_SCRUM_EPIC_FILES",
"TAG": "DOCUMENT ID"
}
}
Returned Data
|
Name |
Description |
|
id |
Epic identifier |
|
groupId |
Group identifier (scrum) to which the epic is attached |
|
name |
Epic name |
|
description |
Epic description |
|
createdBy |
Identifier of the user who created the epic |
|
modifiedBy |
Identifier of the user who last modified the epic |
|
color |
Epic color in HEX format |
|
files |
Object with data about all files attached to the epic |
Error Handling
HTTP status: 400
{
"error": 0,
"error_description": "Access denied"
}
|
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 |
|
|
Access denied |
No access to view epic data |
|
|
Epic not found |
The epic does not exist |
|
|
Could not find value for parameter |
Incorrect parameter name or parameter not set |
|
|
Invalid value {stringValue} to match with parameter {id}. Should be value of type int. |
Invalid parameter type |
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 |