Get the List of Task Template Fields tasks.template.fields
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
The method tasks.template.fields returns the description of the task template fields.
Method Parameters
No parameters.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.template.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/tasks.template.fields
try
{
const response = await $b24.callMethod(
'tasks.template.fields',
{}
);
const result = response.getData().result;
console.log(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'tasks.template.fields',
[]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo 'Error retrieving template fields: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.template.fields',
{},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.template.fields',
[]
);
print_r($result);
Response Handling
HTTP Status: 200
{
"result": {
"ID": {
"title": "ID",
"type": "integer",
"primary": true
},
"PARENT_ID": {
"title": "Parent Task",
"type": "integer",
"default": 0
},
"TITLE": {
"title": "Title",
"type": "string",
"required": true
},
"DESCRIPTION": {
"title": "Description",
"type": "string"
},
"PRIORITY": {
"title": "Priority",
"type": "enum",
"values": {
"2": null,
"1": null,
"0": null
},
"default": 1
},
"GROUP_ID": {
"title": "Project",
"type": "integer",
"default": 0
},
"STAGE_ID": {
"title": "Stage",
"type": "integer",
"default": 0
},
"CREATED_BY": {
"title": "Creator",
"type": "integer",
"required": true
},
"RESPONSIBLE_ID": {
"title": "Responsible",
"type": "integer",
"required": true
},
"DEPENDS_ON": {
"title": "Dependency",
"type": "integer",
"required": true
},
"RESPONSIBLES": {
"title": "Responsible Persons",
"type": "array"
},
"ACCOMPLICES": {
"title": "Participants",
"type": "array"
},
"AUDITORS": {
"title": "Observers",
"type": "array"
},
"STATUS": {
"title": "Status",
"type": "enum",
"values": {
"2": null,
"3": null,
"4": null,
"5": null,
"6": null
},
"default": 2
},
"MULTITASK": {
"title": "Multitask",
"type": "enum",
"values": {
"Y": "Yes",
"N": "No"
},
"default": "N"
},
"REPLICATE": {
"title": "Recurring Task",
"type": "enum",
"values": {
"Y": "Yes",
"N": "No"
},
"default": "N"
},
"SITE_ID": {
"title": "SITE_ID",
"type": "string"
},
"TASK_CONTROL": {
"title": "Accept Work",
"type": "enum",
"values": {
"Y": "Yes",
"N": "No"
},
"default": "N"
},
"ADD_IN_REPORT": {
"title": "Add to Report",
"type": "enum",
"values": {
"Y": "Yes",
"N": "No"
},
"default": "N"
},
"XML_ID": {
"title": "XML_ID",
"type": "string",
"default": null
},
"DEADLINE_AFTER": {
"title": "Deadline After",
"type": "datetime",
"default": null
},
"START_DATE_PLAN_AFTER": {
"title": "Planned Start After",
"type": "datetime",
"default": null
},
"END_DATE_PLAN_AFTER": {
"title": "Planned Completion After",
"type": "datetime",
"default": null
},
"TPARAM_TYPE": {
"title": "For New Users",
"type": "enum",
"values": {
"1": "Yes",
"0": "No"
},
"default": 0
},
"TPARAM_REPLICATION_COUNT": {
"title": "Number of Created Tasks",
"type": "integer",
"default": 0
},
"REPLICATE_PARAMS": {
"title": "Task Creation Parameters",
"type": "string"
},
"BASE_TEMPLATE_ID": {
"title": "Parent Template",
"type": "integer",
"default": null
},
"TEMPLATE_CHILDREN_COUNT": {
"title": "Number of Sub-templates",
"type": "integer",
"default": null
},
"UF_CRM_TASK": {
"title": "Link to CRM Entities",
"type": "crm"
},
"UF_TASK_WEBDAV_FILES": {
"title": "File (Drive)",
"type": "disk_file"
},
"UF_AUTO_291715100499": {
"title": "String",
"type": "string"
},
"UF_AUTO_152207278904": {
"title": "Number",
"type": "double"
}
},
"time": {
"start": 1771919518,
"finish": 1771919518.633086,
"duration": 0.6330859661102295,
"processing": 0,
"date_start": "2026-02-24T10:51:58+01:00",
"date_finish": "2026-02-24T10:51:58+01:00",
"operating_reset_at": 1771920118,
"operating": 0
}
}
Returned Data
|
Title |
Description |
|
result |
Object with task template fields. For each field, an object with a description is returned (detailed description) |
|
time |
Information about the request execution time |
Field Description Object
|
Title |
Description |
|
title |
Field name for display |
|
type |
Field value type |
|
required |
Indicates if the field is required. Not returned for all fields |
|
default |
Default value. Can be a string, number, or |
|
values |
List of allowed values for fields of type list |
|
primary |
Indicates if the field is primary |
Error Handling
|
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 |
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 |
Continue Learning
- Add Task Template tasks.template.add
- Update Task Template tasks.template.update
- Get Task Template by ID tasks.template.get
- Delete Task Template tasks.template.delete