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
// 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 TemplateFieldsResult = {
[fieldName: string]: {
title: string
type: string
required?: boolean
default?: string | number | null
values?: Record<string, string | null>
primary?: boolean
}
}
try {
const response = await $b24.actions.v2.call.make<TemplateFieldsResult>({
method: 'tasks.template.fields',
params: {},
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('Template fields:', Object.keys(result))
}
} 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 getTemplateFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'tasks.template.fields',
params: {},
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('Template fields:', Object.keys(result))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getTemplateFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.template.fields().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 {
$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);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "tasks.template.fields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("tasks.template.fields: %w", err)
}
keys, ok := b24.Keys(res.Result)
if !ok {
return fmt.Errorf("expected an object in the response")
}
fmt.Println("fields in response:", len(keys))
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
|
Name |
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
|
Name |
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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |