Get the List of Fields tasks.task.getFields

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

The method tasks.task.getFields returns a description of standard and custom fields of a task. Use it to find the field codes for fields in tasks.task.add and tasks.task.update, for select and filter in tasks.task.get and tasks.task.list, and the allowed values of list 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.task.getFields
        
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.task.getFields
        
// 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
        
        // A single field descriptor and the map returned in result.fields
        type TaskFieldDescription = {
          title: string | null
          type: string
          required?: boolean
          primary?: boolean
          default?: unknown
          values?: Record<string, string> | string[]
        }
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type TaskFieldsResult = {
          fields: Record<string, TaskFieldDescription>
        }
        
        try {
          // tasks.task.getFields takes no parameters
          const response = await $b24.actions.v2.call.make<TaskFieldsResult>({
            method: 'tasks.task.getFields',
            params: {},
            requestId: Text.getUuidRfc4122() // optional unique tracking id for this request
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const fields = response.getData()!.result.fields
            console.info(`Loaded ${Object.keys(fields).length} task fields`)
          }
        } 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 loadTaskFields() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // tasks.task.getFields takes no parameters
              const response = await $b24.actions.v2.call.make({
                method: 'tasks.task.getFields',
                params: {},
                requestId: B24Js.Text.getUuidRfc4122() // optional unique tracking id for this request
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const fields = response.getData().result.fields
              console.info(`Loaded ${Object.keys(fields).length} task fields`)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', loadTaskFields)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.tasks.task.get_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.task.getFields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching task fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'tasks.task.getFields',
            {},
            function(result){
                console.info(result.data());
                console.log(result);
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'tasks.task.getFields',
            []
        );
        
        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.task.getFields", nil, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("tasks.task.getFields: %w", err)
        }
        
        // The method wraps the response in an object with the "fields" key.
        raw, ok := b24.Unwrap(res.Result, "fields")
        if !ok {
        	return fmt.Errorf("no fields key in the response")
        }
        
        fmt.Printf("%s\n", raw)
        

Response Handling

HTTP Status: 200

{
            "result": {
                "fields": {
                    "ID": {
                        "title": "ID",
                        "type": "integer",
                        "primary": true
                    },
                    "PARENT_ID": {
                        "title": "Base Task ID",
                        "type": "integer",
                        "default": 0
                    },
                    "TITLE": {
                        "title": "Title",
                        "type": "string",
                        "required": true
                    },
                    "DESCRIPTION": {
                        "title": "Description",
                        "type": "string"
                    },
                    "MARK": {
                        "title": "Rating",
                        "type": "enum",
                        "values": {
                            "N": "Negative",
                            "P": "Positive"
                        },
                        "default": null
                    },
                    "PRIORITY": {
                        "title": "Priority",
                        "type": "enum",
                        "values": {
                            "2": "High",
                            "1": "Medium",
                            "0": "Low"
                        },
                        "default": 1
                    },
                    "STATUS": {
                        "title": "Status",
                        "type": "enum",
                        "values": {
                            "2": "Pending",
                            "3": "In Progress",
                            "4": "Awaiting Review",
                            "5": "Completed",
                            "6": "Deferred"
                        },
                        "default": 2
                    },
                    "MULTITASK": {
                        "title": "Multitask",
                        "type": "enum",
                        "values": {
                            "Y": "Yes",
                            "N": "No"
                        },
                        "default": "N"
                    },
                    "NOT_VIEWED": {
                        "title": null,
                        "type": "enum",
                        "values": {
                            "Y": "Yes",
                            "N": "No"
                        },
                        "default": "N"
                    },
                    "REPLICATE": {
                        "title": "Recurring Task",
                        "type": "enum",
                        "values": {
                            "Y": "Yes",
                            "N": "No"
                        },
                        "default": "N"
                    },
                    "GROUP_ID": {
                        "title": "Project",
                        "type": "integer",
                        "default": 0
                    },
                    "STAGE_ID": {
                        "title": "Stage",
                        "type": "integer",
                        "default": 0
                    },
                    "SPRINT_ID": {
                        "title": "Sprint",
                        "type": "integer",
                        "default": 0
                    },
                    "BACKLOG_ID": {
                        "title": "Backlog",
                        "type": "integer",
                        "default": 0
                    },
                    "CREATED_BY": {
                        "title": "Creator",
                        "type": "integer",
                        "required": true
                    },
                    "CREATED_DATE": {
                        "title": null,
                        "type": "datetime"
                    },
                    "RESPONSIBLE_ID": {
                        "title": "Participant",
                        "type": "integer",
                        "required": true
                    },
                    "ACCOMPLICES": {
                        "title": null,
                        "type": "array"
                    },
                    "AUDITORS": {
                        "title": null,
                        "type": "array"
                    },
                    "CHANGED_BY": {
                        "title": "Modified By",
                        "type": "integer"
                    },
                    "CHANGED_DATE": {
                        "title": "Modification Date",
                        "type": "datetime"
                    },
                    "STATUS_CHANGED_BY": {
                        "title": "Status Changed By",
                        "type": "integer"
                    },
                    "STATUS_CHANGED_DATE": {
                        "title": "Status Change Date",
                        "type": "datetime"
                    },
                    "CLOSED_BY": {
                        "title": "Closed By",
                        "type": "integer",
                        "default": null
                    },
                    "CLOSED_DATE": {
                        "title": "Closure Date",
                        "type": "datetime",
                        "default": null
                    },
                    "ACTIVITY_DATE": {
                        "title": null,
                        "type": "datetime",
                        "default": null
                    },
                    "DATE_START": {
                        "title": "Start Date",
                        "type": "datetime",
                        "default": null
                    },
                    "DEADLINE": {
                        "title": "Deadline",
                        "type": "datetime",
                        "default": null
                    },
                    "START_DATE_PLAN": {
                        "title": "Planned Start",
                        "type": "datetime",
                        "default": null
                    },
                    "END_DATE_PLAN": {
                        "title": "Planned Completion",
                        "type": "datetime",
                        "default": null
                    },
                    "GUID": {
                        "title": "GUID",
                        "type": "string",
                        "default": null
                    },
                    "XML_ID": {
                        "title": "XML_ID",
                        "type": "string",
                        "default": null
                    },
                    "COMMENTS_COUNT": {
                        "title": "Number of Comments",
                        "type": "integer",
                        "default": 0
                    },
                    "SERVICE_COMMENTS_COUNT": {
                        "title": null,
                        "type": "integer",
                        "default": 0
                    },
                    "NEW_COMMENTS_COUNT": {
                        "title": null,
                        "type": "integer",
                        "default": 0
                    },
                    "ALLOW_CHANGE_DEADLINE": {
                        "title": null,
                        "type": "enum",
                        "values": {
                            "Y": "Yes",
                            "N": "No"
                        },
                        "default": "N"
                    },
                    "ALLOW_TIME_TRACKING": {
                        "title": null,
                        "type": "enum",
                        "values": {
                            "Y": "Yes",
                            "N": "No"
                        },
                        "default": "N"
                    },
                    "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"
                    },
                    "FORKED_BY_TEMPLATE_ID": {
                        "title": "Created from Template",
                        "type": "enum",
                        "values": {
                            "Y": "Yes",
                            "N": "No"
                        },
                        "default": "N"
                    },
                    "TIME_ESTIMATE": {
                        "title": "Estimated Time",
                        "type": "integer"
                    },
                    "TIME_SPENT_IN_LOGS": {
                        "title": "Time Spent from Change History",
                        "type": "integer"
                    },
                    "MATCH_WORK_TIME": {
                        "title": "Skip Weekends",
                        "type": "integer"
                    },
                    "FORUM_TOPIC_ID": {
                        "title": "FORUM_TOPIC_ID",
                        "type": "integer"
                    },
                    "FORUM_ID": {
                        "title": "FORUM_ID",
                        "type": "integer"
                    },
                    "SITE_ID": {
                        "title": "SITE_ID",
                        "type": "string"
                    },
                    "SUBORDINATE": {
                        "title": "Subordinate Task",
                        "type": "enum",
                        "values": {
                            "Y": "Yes",
                            "N": "No"
                        },
                        "default": null
                    },
                    "FAVORITE": {
                        "title": null,
                        "type": "enum",
                        "values": {
                            "Y": "Yes",
                            "N": "No"
                        },
                        "default": null
                    },
                    "EXCHANGE_MODIFIED": {
                        "title": "EXCHANGE_MODIFIED",
                        "type": "datetime",
                        "default": null
                    },
                    "EXCHANGE_ID": {
                        "title": "EXCHANGE_ID",
                        "type": "integer",
                        "default": null
                    },
                    "OUTLOOK_VERSION": {
                        "title": "OUTLOOK_VERSION",
                        "type": "integer",
                        "default": null
                    },
                    "VIEWED_DATE": {
                        "title": "Last Viewed Date",
                        "type": "datetime"
                    },
                    "SORTING": {
                        "title": "Sorting Index",
                        "type": "double"
                    },
                    "DURATION_PLAN": {
                        "title": "Spent (planned)",
                        "type": "integer"
                    },
                    "DURATION_FACT": {
                        "title": "Spent (actual)",
                        "type": "integer"
                    },
                    "CHECKLIST": {
                        "title": null,
                        "type": "array"
                    },
                    "DURATION_TYPE": {
                        "title": "DURATION_TYPE",
                        "type": "enum",
                        "values": [
                            "secs",
                            "mins",
                            "hours",
                            "days",
                            "weeks",
                            "months",
                            "years"
                        ],
                        "default": "days"
                    },
                    "IS_MUTED": {
                        "title": null,
                        "type": "enum",
                        "values": {
                            "Y": "Yes",
                            "N": "No"
                        },
                        "default": "N"
                    },
                    "IS_PINNED": {
                        "title": null,
                        "type": "enum",
                        "values": {
                            "Y": "Yes",
                            "N": "No"
                        },
                        "default": "N"
                    },
                    "IS_PINNED_IN_GROUP": {
                        "title": null,
                        "type": "enum",
                        "values": {
                            "Y": "Yes",
                            "N": "No"
                        },
                        "default": "N"
                    },
                    "FLOW_ID": {
                        "title": "Flow",
                        "type": "integer",
                        "default": 0
                    },
                    "UF_CRM_TASK": {
                        "title": "CRM Entities",
                        "type": "crm"
                    },
                    "UF_TASK_WEBDAV_FILES": {
                        "title": "Upload Files",
                        "type": "disk_file"
                    },
                    "UF_MAIL_MESSAGE": {
                        "title": null,
                        "type": "mail_message"
                    },
                    "UF_NEW_TASKS_FIELD": {
                        "title": "New Task Field",
                        "type": "string"
                    }
                }
            },
            "time": {
                "start": 1758790899,
                "finish": 1758790899.809331,
                "duration": 0.809330940246582,
                "processing": 0,
                "date_start": "2025-09-25T12:01:39+02:00",
                "date_finish": "2025-09-25T12:01:39+02:00",
                "operating_reset_at": 1758791499,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Root object of the response

fields
object

An object where each key is a task field code, such as TITLE or UF_CRM_TASK, and each value is an object describing the field (detailed description).

Contains standard and custom task fields. The purpose of standard fields is described in the Task Fields article

time
time

Information about the request execution time

Field Description Object

Name
type

Description

title
string

Field name. For some fields, null is returned, for example for ACCOMPLICES, AUDITORS, CREATED_DATE

type
string

Type of the field value. Possible values:

  • integer — integer
  • double — floating-point number
  • string — string
  • boolean — boolean value
  • datetime — date and time
  • enum — a value from the values list
  • array — array
  • crm — link to CRM objects
  • disk_file — Drive files
  • mail_message — link to an email

values
object | array

Allowed field values. Returned only for fields of the enum type.

Usually an object where each key is a field value and each value is its label, for example {"Y": "Yes", "N": "No"}. For the DURATION_TYPE field, an array of values without labels is returned

default
integer | string

Default value. Can be null. Returned only for fields that have a default value

required
boolean

Required field flag. Returned with the value true only for required fields: TITLE, CREATED_BY, RESPONSIBLE_ID

primary
boolean

Primary key flag. Returned with the value true only for the ID field

Error Handling

HTTP Status: 401

{
            "error": "INVALID_CREDENTIALS",
            "error_description": "Invalid request credentials"
        }
        

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

The method has no parameters, so it has no method-specific errors. It can return only system errors, for example INVALID_CREDENTIALS if the webhook code is invalid.

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