Get a list of available fields for epic tasks.api.scrum.epic.getFields

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: task

Who can execute the method: any user

The method tasks.api.scrum.epic.getFields returns the available fields for an epic.

No parameters.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
        }' \
        https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.epic.getFields
        
curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
        auth=YOUR_ACCESS_TOKEN
        }' \
        https://your-domain.bitrix24.com/rest/tasks.api.scrum.epic.getFields
        
try
        {
        	const response = await $b24.callMethod(
        		'tasks.api.scrum.epic.getFields',
        		{}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.api.scrum.epic.getFields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting epic fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'tasks.api.scrum.epic.getFields',
            {},
            function(res)
            {
                console.log(res);
            }
        );
        
require_once('crest.php'); // connecting CRest PHP SDK
        
        // executing a request to the REST API
        $result = CRest::call(
        'tasks.api.scrum.epic.getFields',
        []
        );
        
        // Processing the response from Bitrix24
        if ($result['error']) {
            echo 'Error: '.$result['error_description'];
        }
        else {
            print_r($result['result']);
        }

Response Handling

HTTP status: 400

{
            "fields":
            {
                "name": {
                    "type": "string"
                },
                "description": {
                    "type": "string"
                },
                "groupId": {
                    "type": "integer"
                },
                "color": {
                    "type": "string"
                },
                "files": {
                    "type": "array"
                },
                "createdBy": {
                    "type": "integer"
                },
                "modifiedBy": {
                    "type": "integer"
                }
            }
        }

Returned Data

Field type

Description

name string

Epic name

description string

Epic description

groupId integer

Identifier of the group (scrum) to which the epic belongs

color string

Epic color

files array

Array of files attached to the epic

createdBy integer

Created by

modifiedBy integer

Modified by

Error Handling

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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

Continue Learning

Previous
Delete Epic
Next
Overview of Methods