Get Epic Fields by Its Identifier tasks.api.scrum.epic.get

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: task

Who 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
type

Description

id*
integer

Epic identifier.

You can get the identifiers of epics using the method tasks.api.scrum.epic.list

withFiles
boolean

Whether to return the epic files in the files field. Defaults to true.

To retrieve an epic without files, pass false or 0

Attention

The method treats the strings "false" and "N" in withFiles as true and returns the files. Pass a boolean false in a JSON request, or 0

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

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>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.tasks.api.scrum.epic.get(
                bitrix_id=1,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

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>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "tasks.api.scrum.epic.get", b24.Params{
        	"id": 1,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("tasks.api.scrum.epic.get: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)

Response Handling

HTTP status: 200

{
            "result": {
                "id": 2,
                "groupId": 2,
                "name": "User Registration",
                "description": "Login form, registration, and password recovery",
                "createdBy": 1,
                "modifiedBy": 1,
                "color": "#69dafc",
                "files": {
                    "ID": "60",
                    "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": [
                        6
                    ],
                    "ENTITY_VALUE_ID": 2,
                    "VALUE_EXISTS": true,
                    "VALUE_RAW": "a:1:{i:0;i:6;}",
                    "CUSTOM_DATA": {
                        "PHOTO_TEMPLATE": ""
                    },
                    "EDIT_FORM_LABEL": "UF_SCRUM_EPIC_FILES",
                    "TAG": "DOCUMENT ID"
                }
            },
            "time": {
                "start": 1790263942,
                "finish": 1790263942.418237,
                "duration": 0.4182369709014893,
                "processing": 0,
                "date_start": "2026-09-24T18:32:22+03:00",
                "date_finish": "2026-09-24T18:32:22+03:00",
                "operating_reset_at": 1790264542,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Epic data (Detailed Description)
time `time`	Information about the request execution time

result Object

Name `type`	Description
id `integer`	Epic identifier
groupId `integer`	Identifier of the Scrum to which the epic belongs
name `string`	Epic name
description `string`	Epic description
createdBy `integer`	Identifier of the user who created the epic
modifiedBy `integer`	Identifier of the user who last modified the epic. `0` if the epic has not been modified
color `string`	Epic color
files `object`	Epic files as the `UF_SCRUM_EPIC_FILES` custom field (Detailed Description)

files Object

The file data you need is in the VALUE field. The other fields of the object contain internal metadata describing the custom field.

Name `type`	Description
VALUE `array`	Identifiers of the files attached to the epic. These are attachment identifiers, not Drive file identifiers: you can retrieve the file name, download link, and Drive file identifier `OBJECT_ID` using the disk.attachedObject.get method. An empty array if there are no files
VALUE_EXISTS `boolean`	Returned with the value `true` if files are attached to the epic. If there are no files, this field is absent from the response
FIELD_NAME `string`	Custom field code, always `UF_SCRUM_EPIC_FILES`
USER_TYPE_ID `string`	Custom field type, always `disk_file`
ENTITY_VALUE_ID `integer`	Epic identifier
VALUE_RAW `string`	The `VALUE` value in PHP serialized form. If there are no files, this field is absent from the response

The remaining fields describe the settings of the UF_SCRUM_EPIC_FILES custom field itself. They are the same for all epics and do not depend on the attached files:

Name `type`	Description
ID `string`	Custom field identifier
ENTITY_ID `string`	Object the field belongs to, always `TASKS_SCRUM_EPIC`
XML_ID `string` \| `null`	External code of the field. `null` for the epic files field
SORT `string`	Field sort order
MULTIPLE `string`	Whether the field accepts multiple values, always `Y`
MANDATORY `string`	Whether the field is required, always `N`
SHOW_FILTER, SHOW_IN_LIST, EDIT_IN_LIST, IS_SEARCHABLE `string`	Field display settings in the interface, `Y` or `N`
SETTINGS `object`	Field settings: `IBLOCK_ID`, `SECTION_ID`, `UF_TO_SAVE_ALLOW_EDIT`
USER_TYPE `object`	Field type description: `USER_TYPE_ID`, `CLASS_NAME`, `DESCRIPTION`, `BASE_TYPE`, `TAG`
CUSTOM_DATA `object`	Additional data of the field type
EDIT_FORM_LABEL `string`	Field label in the edit form
TAG `string`	Field type tag, `DOCUMENT ID`

Error Handling

HTTP status: 400

{
            "error": "0",
            "error_description": "Access denied"
        }

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status	Code	Description	Value
`400`	`0`	Epic not found	An epic with this `id` does not exist
`400`	`0`	Access denied	The user has no access to the tasks of the group the epic belongs to
`400`	`100`	Could not find value for parameter	The `id` parameter was not passed
`400`	`100`	Invalid value {stringValue} to match with parameter {id}. Should be value of type int.	A non-numeric value was passed in `id`

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it 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

Continue Learning

Was the article helpful?

Update Epic in Scrum

Get List of Epics

Get Epic Fields by Its Identifier tasks.api.scrum.epic.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

result Objectresult Object

files Objectfiles Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning