Получить список доступных полей спринта tasks.api.scrum.sprint.getFields

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: task

Кто может выполнять метод: любой пользователь

Метод tasks.api.scrum.sprint.getFields возвращает доступные поля спринта.

Без параметров.

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
        }' \
        https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.sprint.getFields
        
curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
        auth=YOUR_ACCESS_TOKEN
        }' \
        https://your-domain.bitrix24.com/rest/tasks.api.scrum.sprint.getFields
        
try
        {
        	const response = await $b24.callMethod(
        		'tasks.api.scrum.sprint.getFields',
        		{}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.api.scrum.sprint.getFields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting sprint fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'tasks.api.scrum.sprint.getFields',
            {},
            function(res)
            {
                console.log(res);
            }
        );
        
require_once('crest.php'); // подключение CRest PHP SDK
        
        // выполнение запроса к REST API
        $result = CRest::call(
        'tasks.api.scrum.sprint.getFields',
        []
        );
        
        // Обработка ответа от Битрикс24
        if ($result['error']) {
        echo 'Error: '.$result['error_description'];
        } else {
        print_r($result['result']);
        }

Обработка ответа

HTTP-статус: 200

{
            "result":
            {
                "fields":
                {
                    "groupId":
                    {
                        "type": "integer"
                    },
                    "name":
                    {
                        "type": "string"
                    },
                    "sort":
                    {
                        "type": "integer"
                    },
                    "createdBy":
                    {
                        "type": "integer"
                    },
                    "modifiedBy":
                    {
                        "type": "integer"
                    },
                    "dateStart":
                    {
                        "type": "string"
                    },
                    "dateEnd":
                    {
                        "type": "string"
                    },
                    "status":
                    {
                        "type": "string"
                    }
                }
            }
        }

Возвращаемые данные

Название
тип

Описание

groupId
integer

Идентификатор группы (Скрама), к которой относится спринт

name
string

Название спринта

sort
integer

Сортировка

createdBy
integer

Идентификатор пользователя, создавшего спринт

modifiedBy
integer

Идентификатор пользователя, изменившего спринт

dateStart
string

Дата начала спринта в формате ISO 8601

dateEnd
string

Дата окончания спринта в формате ISO 8601

status
string

Статус спринта

Обработка ошибок

Метод не возвращает ошибок.

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Удалить спринт
Следующая
Обзор методов