Retrieve Fields of a Timeline Record Binding with a CRM Entity crm.timeline.bindings.fields

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

Who can execute the method: any user

Retrieves the description of the fields of the binding between a timeline record and a CRM entity.

The method helps check the composition of the fields and whether they are required before adding a binding, and retrieve their names in the interface language.

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**/crm.timeline.bindings.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/crm.timeline.bindings.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
        
        type FieldInfo = {
          type: string
          isRequired: boolean
          isReadOnly: boolean
          isImmutable: boolean
          isMultiple: boolean
          isDynamic: boolean
          title: string
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type BindingsFieldsResult = Record<string, FieldInfo>
        
        try {
          const response = await $b24.actions.v2.call.make<BindingsFieldsResult>({
            method: 'crm.timeline.bindings.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(Object.keys(result), result['OWNER_ID'])
          }
        } 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@2/dist/umd/index.min.js"></script>
        <script>
          async function getTimelineBindingsFields() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.timeline.bindings.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(Object.keys(result), result['OWNER_ID'])
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getTimelineBindingsFields)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.timeline.bindings.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(
                    'crm.timeline.bindings.fields'
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching timeline bindings fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.timeline.bindings.fields",
            {},
            result => {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.timeline.bindings.fields'
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.timeline.bindings.fields", nil, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.timeline.bindings.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": {
                "OWNER_ID": {
                    "type": "integer",
                    "isRequired": true,
                    "isReadOnly": false,
                    "isImmutable": true,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Timeline record ID"
                },
                "ENTITY_ID": {
                    "type": "integer",
                    "isRequired": true,
                    "isReadOnly": false,
                    "isImmutable": true,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Element ID"
                },
                "ENTITY_TYPE": {
                    "type": "string",
                    "isRequired": true,
                    "isReadOnly": false,
                    "isImmutable": true,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Element type"
                }
            },
            "time": {
                "start": 1715091541.642592,
                "finish": 1715091541.730599,
                "duration": 0.08800697326660156,
                "date_start": "2024-05-03T17:19:01+03:00",
                "date_finish": "2024-05-03T17:19:01+03:00",
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response. The key is the name of a binding field from the fields list, and the value is an object with the field description

time
time

Information about the request execution time

Fields List

Name
type

Description

OWNER_ID
integer

Identifier of the timeline record. Obtain it from the response of the method crm.timeline.comment.add or crm.timeline.logmessage.add, or retrieve it from the list using the method crm.timeline.comment.list or crm.timeline.logmessage.list. Required, immutable

ENTITY_ID
integer

Identifier of the CRM entity to which the timeline record is bound. Required, immutable

ENTITY_TYPE
string

String code of the CRM object type entityTypeName to which the timeline record is bound. Required, immutable. Possible values:

  • lead — lead
  • deal — deal
  • contact — contact
  • company — company
  • quote — quote
  • smart_invoice — invoice
  • order — order
  • activity — activity
  • dynamic_<entityTypeId> — smart process item, for example dynamic_128

The method crm.timeline.bindings.bind also accepts other CRM object types, for example invoice — an invoice in the old format. How the string type codes are structured is described in the section CRM Object Type

The field types describe the values accepted by the method crm.timeline.bindings.bind. In the response of the method crm.timeline.bindings.list, the values of all three fields are returned as strings.

Field Description

Name
type

Description

type
string

Type of the field value: integer or string

isRequired
boolean

Whether the field is required

isReadOnly
boolean

Whether the field is read-only

isImmutable
boolean

Whether the field cannot be changed after the binding is created. To change a binding, remove it with the method crm.timeline.bindings.unbind and create it again

isMultiple
boolean

Whether the field is multiple

isDynamic
boolean

Whether the field is a custom field. For binding fields, it is always false

title
string

Name of the field in the interface language

Error Handling

The method has no errors of its own: it takes no parameters, and the composition of the fields is the same in any Bitrix24. Only system errors are possible, for example, in case of invalid authorization.

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

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