Access Available User Messages from the News Feed log.blogpost.get

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

Who can execute the method: any user

The method log.blogpost.get returns messages from the News Feed that are accessible to the current user.

Method Parameters

Required parameters are marked with *

Name
type

Description

POST_ID
integer

Filter by message ID.

You can obtain the ID using the log.blogpost.get method.

LOG_RIGHTS
array

Filter by recipients who have the right to view the message.

Possible values:

  • SG<X> — workgroups and projects with the identifier X. You can retrieve the identifier using the sonet_group.get method
  • U<X> — users with the identifier X. You can retrieve the identifier using the user.get method
  • UA — all authorized users
  • DR<X> — company departments with the identifier X. You can retrieve the identifier using the department.get method

LOG_DATE_FROM
string

Lower boundary of the post publication period in ISO 8601 format. If LOG_DATE_FROM and LOG_DATE_TO are specified, the LOG_DATE_FROM value must not be later than LOG_DATE_TO

LOG_DATE_TO
string

Upper boundary of the post publication period in ISO 8601 format. If the value is not specified, the upper boundary of the period is not applied

FIRST_ID
integer

News Feed entry identifier for cursor-based forward navigation. The method returns posts with identifiers greater than the specified value. If FIRST_ID and LAST_ID are passed, FIRST_ID is applied

LAST_ID
integer

News Feed entry identifier for cursor-based backward navigation. The method returns posts with identifiers less than the specified value

LIMIT
integer

Page size in cursor mode. A non-positive or non-numeric value is replaced with the default value. The maximum value is 200

start
integer

This parameter is used for pagination control.

The page size of results is always static — 50 records.

To select the second page of results, you need to pass the value 50. To select the third page of results — the value 100, and so on.

The formula for calculating the start parameter value:

start = (N - 1) * 50, where N is the desired page number.

If the POST_ID and LOG_RIGHTS parameters are not specified, all messages available to the current user are returned. The parameters are mutually exclusive: if POST_ID is specified, filtering by LOG_RIGHTS is ignored.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"POST_ID":217}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/log.blogpost.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"POST_ID":217,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/log.blogpost.get
        
// 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, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of each BlogPostItem returned in result[]
        type BlogPostItem = {
          ID: string
          BLOG_ID: string
          PUBLISH_STATUS: string
          TITLE: string
          AUTHOR_ID: string
          ENABLE_COMMENTS: string
          NUM_COMMENTS: string
          CODE: string | null
          MICRO: string
          DETAIL_TEXT: string
          DATE_PUBLISH: ISODate | null
          CATEGORY_ID: string
          HAS_SOCNET_ALL: string
          HAS_TAGS: string
          HAS_IMAGES: string
          HAS_PROPS: string
          HAS_COMMENT_IMAGES: string | null
          FILES: number[]
        }
        
        try {
          // log.blogpost.get returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<BlogPostItem[]>({
            method: 'log.blogpost.get',
            params: {
              POST_ID: 217,
              start: 0,
            },
            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('Blog posts count:', result.length, 'First post title:', result[0]?.TITLE)
          }
        } 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 getBlogPosts() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // log.blogpost.get returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'log.blogpost.get',
                params: {
                  POST_ID: 217,
                  start: 0,
                },
                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('Blog posts count:', result.length, 'First post title:', result[0]?.TITLE)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getBlogPosts)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.log.blogpost.get(
                post_id=217,
                start=0,
            ).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(
                    'log.blogpost.get',
                    [
                        'POST_ID' => 217
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error retrieving blog post: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'log.blogpost.get',
            {
                POST_ID: 217
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error(), result.error_description());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'log.blogpost.get',
            [
                'POST_ID' => 217
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "log.blogpost.get", b24.Params{
        	"POST_ID": 217,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("log.blogpost.get: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)

Response Handling

HTTP Status: 200

Example response:

{
            "result": [
                {
                "ID": "217",
                "BLOG_ID": "299",
                "PUBLISH_STATUS": "P",
                "TITLE": "New Regulations",
                "AUTHOR_ID": "1269",
                "ENABLE_COMMENTS": "Y",
                "NUM_COMMENTS": "0",
                "CODE": null,
                "MICRO": "N",
                "DETAIL_TEXT": "The approval process will be updated starting November 1.",
                "DATE_PUBLISH": "2026-03-17T15:29:15+01:00",
                "CATEGORY_ID": "9,11,13",
                "HAS_SOCNET_ALL": "N",
                "HAS_TAGS": "Y",
                "HAS_IMAGES": "N",
                "HAS_PROPS": "Y",
                "HAS_COMMENT_IMAGES": null,
                "UF_BLOG_POST_DOC": {
                    "ID": "1",
                    "ENTITY_ID": "BLOG_POST",
                    "FIELD_NAME": "UF_BLOG_POST_DOC",
                    "USER_TYPE_ID": "file",
                    "XML_ID": "UF_BLOG_POST_DOC",
                    "SORT": "100",
                    "MULTIPLE": "Y",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "N",
                    "EDIT_IN_LIST": "Y",
                    "IS_SEARCHABLE": "Y",
                    "SETTINGS": {
                    "SIZE": 20,
                    "LIST_WIDTH": 0,
                    "LIST_HEIGHT": 0,
                    "MAX_SHOW_SIZE": 0,
                    "MAX_ALLOWED_SIZE": 0,
                    "EXTENSIONS": [],
                    "TARGET_BLANK": "Y",
                    "DEFAULT_VIEW": null
                    },
                    "EDIT_FORM_LABEL": null,
                    "LIST_COLUMN_LABEL": null,
                    "LIST_FILTER_LABEL": null,
                    "ERROR_MESSAGE": null,
                    "HELP_MESSAGE": null,
                    "USER_TYPE": {
                    "USER_TYPE_ID": "file",
                    "CLASS_NAME": "Bitrix\Main\UserField\Types\FileType",
                    "EDIT_CALLBACK": ["Bitrix\Main\UserField\Types\FileType", "renderEdit"],
                    "VIEW_CALLBACK": ["Bitrix\Main\UserField\Types\FileType", "renderView"],
                    "USE_FIELD_COMPONENT": true,
                    "DESCRIPTION": "File",
                    "BASE_TYPE": "file"
                    },
                    "VALUE": false,
                    "ENTITY_VALUE_ID": 217,
                    "VALUE_EXISTS": true,
                    "VALUE_RAW": null,
                    "CUSTOM_DATA": []
                },
                "UF_BLOG_POST_URL_PRV": {
                    "ID": "5",
                    "ENTITY_ID": "BLOG_POST",
                    "FIELD_NAME": "UF_BLOG_POST_URL_PRV",
                    "USER_TYPE_ID": "url_preview",
                    "XML_ID": "UF_BLOG_POST_URL_PRV",
                    "SORT": "100",
                    "MULTIPLE": "N",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "N",
                    "EDIT_IN_LIST": "Y",
                    "IS_SEARCHABLE": "Y",
                    "SETTINGS": [],
                    "EDIT_FORM_LABEL": null,
                    "LIST_COLUMN_LABEL": null,
                    "LIST_FILTER_LABEL": null,
                    "ERROR_MESSAGE": null,
                    "HELP_MESSAGE": null,
                    "USER_TYPE": {
                    "USER_TYPE_ID": "url_preview",
                    "CLASS_NAME": "Bitrix\Main\UrlPreview\UrlPreviewUserType",
                    "DESCRIPTION": "Link preview content",
                    "BASE_TYPE": "int"
                    },
                    "VALUE": null,
                    "ENTITY_VALUE_ID": 217,
                    "VALUE_EXISTS": true,
                    "VALUE_RAW": null,
                    "CUSTOM_DATA": []
                },
                "UF_GRATITUDE": {
                    "ID": "9",
                    "ENTITY_ID": "BLOG_POST",
                    "FIELD_NAME": "UF_GRATITUDE",
                    "USER_TYPE_ID": "integer",
                    "XML_ID": "UF_GRATITUDE",
                    "SORT": "100",
                    "MULTIPLE": "N",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "N",
                    "EDIT_IN_LIST": "Y",
                    "IS_SEARCHABLE": "N",
                    "SETTINGS": {
                    "SIZE": 20,
                    "MIN_VALUE": 0,
                    "MAX_VALUE": 0,
                    "DEFAULT_VALUE": null
                    },
                    "EDIT_FORM_LABEL": null,
                    "LIST_COLUMN_LABEL": null,
                    "LIST_FILTER_LABEL": null,
                    "ERROR_MESSAGE": null,
                    "HELP_MESSAGE": null,
                    "USER_TYPE": {
                    "USER_TYPE_ID": "integer",
                    "CLASS_NAME": "Bitrix\Main\UserField\Types\IntegerType",
                    "EDIT_CALLBACK": ["Bitrix\Main\UserField\Types\IntegerType", "renderEdit"],
                    "VIEW_CALLBACK": ["Bitrix\Main\UserField\Types\IntegerType", "renderView"],
                    "USE_FIELD_COMPONENT": true,
                    "DESCRIPTION": "Integer",
                    "BASE_TYPE": "int"
                    },
                    "VALUE": null,
                    "ENTITY_VALUE_ID": 217,
                    "VALUE_EXISTS": true,
                    "VALUE_RAW": null,
                    "CUSTOM_DATA": []
                },
                "UF_BLOG_POST_FILE": {
                    "ID": "19",
                    "ENTITY_ID": "BLOG_POST",
                    "FIELD_NAME": "UF_BLOG_POST_FILE",
                    "USER_TYPE_ID": "disk_file",
                    "XML_ID": "UF_BLOG_POST_FILE",
                    "SORT": "100",
                    "MULTIPLE": "Y",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "N",
                    "EDIT_IN_LIST": "Y",
                    "IS_SEARCHABLE": "Y",
                    "SETTINGS": {
                    "IBLOCK_ID": null,
                    "SECTION_ID": null,
                    "UF_TO_SAVE_ALLOW_EDIT": false
                    },
                    "EDIT_FORM_LABEL": null,
                    "LIST_COLUMN_LABEL": null,
                    "LIST_FILTER_LABEL": null,
                    "ERROR_MESSAGE": null,
                    "HELP_MESSAGE": null,
                    "USER_TYPE": {
                    "USER_TYPE_ID": "disk_file",
                    "CLASS_NAME": "Bitrix\Disk\Uf\FileUserType",
                    "DESCRIPTION": "File (Drive)",
                    "BASE_TYPE": "int",
                    "TAG": ["DISK FILE ID", "DOCUMENT ID"]
                    },
                    "VALUE": [505],
                    "ENTITY_VALUE_ID": 217,
                    "VALUE_EXISTS": true,
                    "VALUE_RAW": "a:1:{i:0;i:505;}",
                    "CUSTOM_DATA": {
                    "PHOTO_TEMPLATE": "gallery"
                    }
                },
                "UF_BLOG_POST_IMPRTNT": {
                    "ID": "83",
                    "ENTITY_ID": "BLOG_POST",
                    "FIELD_NAME": "UF_BLOG_POST_IMPRTNT",
                    "USER_TYPE_ID": "integer",
                    "XML_ID": "UF_BLOG_POST_IMPRTNT",
                    "SORT": "100",
                    "MULTIPLE": "N",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "Y",
                    "EDIT_IN_LIST": "Y",
                    "IS_SEARCHABLE": "N",
                    "SETTINGS": {
                    "SIZE": 20,
                    "MIN_VALUE": 0,
                    "MAX_VALUE": 0,
                    "DEFAULT_VALUE": null
                    },
                    "EDIT_FORM_LABEL": "Important Message",
                    "LIST_COLUMN_LABEL": "Important",
                    "LIST_FILTER_LABEL": "Important",
                    "ERROR_MESSAGE": null,
                    "HELP_MESSAGE": null,
                    "USER_TYPE": {
                    "USER_TYPE_ID": "integer",
                    "CLASS_NAME": "Bitrix\Main\UserField\Types\IntegerType",
                    "EDIT_CALLBACK": ["Bitrix\Main\UserField\Types\IntegerType", "renderEdit"],
                    "VIEW_CALLBACK": ["Bitrix\Main\UserField\Types\IntegerType", "renderView"],
                    "USE_FIELD_COMPONENT": true,
                    "DESCRIPTION": "Integer",
                    "BASE_TYPE": "int"
                    },
                    "VALUE": null,
                    "ENTITY_VALUE_ID": 217,
                    "VALUE_EXISTS": true,
                    "VALUE_RAW": null,
                    "CUSTOM_DATA": []
                },
                "UF_IMPRTANT_DATE_END": {
                    "ID": "85",
                    "ENTITY_ID": "BLOG_POST",
                    "FIELD_NAME": "UF_IMPRTANT_DATE_END",
                    "USER_TYPE_ID": "datetime",
                    "XML_ID": "UF_IMPRTANT_DATE_END",
                    "SORT": "100",
                    "MULTIPLE": "N",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "N",
                    "EDIT_IN_LIST": "Y",
                    "IS_SEARCHABLE": "N",
                    "SETTINGS": {
                    "DEFAULT_VALUE": {
                        "TYPE": "NONE",
                        "VALUE": ""
                    },
                    "USE_SECOND": "Y",
                    "USE_TIMEZONE": "N"
                    },
                    "EDIT_FORM_LABEL": "Expiration Date",
                    "LIST_COLUMN_LABEL": "Expiration",
                    "LIST_FILTER_LABEL": null,
                    "ERROR_MESSAGE": null,
                    "HELP_MESSAGE": null,
                    "USER_TYPE": {
                    "USER_TYPE_ID": "datetime",
                    "CLASS_NAME": "Bitrix\Main\UserField\Types\DateTimeType",
                    "EDIT_CALLBACK": ["Bitrix\Main\UserField\Types\DateTimeType", "renderEdit"],
                    "VIEW_CALLBACK": ["Bitrix\Main\UserField\Types\DateTimeType", "renderView"],
                    "USE_FIELD_COMPONENT": true,
                    "DESCRIPTION": "Date with time",
                    "BASE_TYPE": "datetime"
                    },
                    "VALUE": "",
                    "ENTITY_VALUE_ID": 217,
                    "VALUE_EXISTS": true,
                    "VALUE_RAW": null,
                    "CUSTOM_DATA": []
                },
                "UF_BLOG_POST_VOTE": {
                    "ID": "131",
                    "ENTITY_ID": "BLOG_POST",
                    "FIELD_NAME": "UF_BLOG_POST_VOTE",
                    "USER_TYPE_ID": "vote",
                    "XML_ID": "UF_BLOG_POST_VOTE",
                    "SORT": "100",
                    "MULTIPLE": "N",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "Y",
                    "EDIT_IN_LIST": "Y",
                    "IS_SEARCHABLE": "N",
                    "SETTINGS": {
                    "CHANNEL_ID": 1,
                    "UNIQUE": 8,
                    "UNIQUE_IP_DELAY": {
                        "DELAY": "10",
                        "DELAY_TYPE": "D"
                    },
                    "NOTIFY": "I"
                    },
                    "EDIT_FORM_LABEL": null,
                    "LIST_COLUMN_LABEL": null,
                    "LIST_FILTER_LABEL": null,
                    "ERROR_MESSAGE": null,
                    "HELP_MESSAGE": null,
                    "USER_TYPE": {
                    "USER_TYPE_ID": "vote",
                    "CLASS_NAME": "Bitrix\Vote\Uf\VoteUserType",
                    "DESCRIPTION": "Poll",
                    "BASE_TYPE": "int"
                    },
                    "VALUE": null,
                    "ENTITY_VALUE_ID": 217,
                    "VALUE_EXISTS": true,
                    "VALUE_RAW": null,
                    "CUSTOM_DATA": []
                },
                "UF_MAIL_MESSAGE": {
                    "ID": "439",
                    "ENTITY_ID": "BLOG_POST",
                    "FIELD_NAME": "UF_MAIL_MESSAGE",
                    "USER_TYPE_ID": "mail_message",
                    "XML_ID": "",
                    "SORT": "100",
                    "MULTIPLE": "N",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "N",
                    "EDIT_IN_LIST": "Y",
                    "IS_SEARCHABLE": "N",
                    "SETTINGS": null,
                    "EDIT_FORM_LABEL": null,
                    "LIST_COLUMN_LABEL": null,
                    "LIST_FILTER_LABEL": null,
                    "ERROR_MESSAGE": null,
                    "HELP_MESSAGE": null,
                    "USER_TYPE": {
                    "USER_TYPE_ID": "mail_message",
                    "CLASS_NAME": "Bitrix\Mail\MessageUserType",
                    "DESCRIPTION": "Email",
                    "BASE_TYPE": "int",
                    "VIEW_CALLBACK": ["Bitrix\Mail\MessageUserType", "getPublicView"],
                    "EDIT_CALLBACK": ["Bitrix\Mail\MessageUserType", "getPublicEdit"],
                    "onBeforeSave": ["Bitrix\Mail\MessageUserType", "onBeforeSave"],
                    "onDelete": ["Bitrix\Mail\MessageUserType", "onDelete"]
                    },
                    "VALUE": null,
                    "ENTITY_VALUE_ID": 217,
                    "VALUE_EXISTS": true,
                    "VALUE_RAW": null,
                    "CUSTOM_DATA": []
                },
                "FILES": [505]
                }
            ],
            "total": 1,
            "time": {
                "start": 1773754540,
                "finish": 1773754540.902101,
                "duration": 0.9021010398864746,
                "processing": 0,
                "date_start": "2026-03-17T16:35:40+01:00",
                "date_finish": "2026-03-17T16:35:40+01:00",
                "operating_reset_at": 1773755140,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
array

Parameters of the message or a list of messages from the News Feed.

An empty array means there are no records that meet the filter criteria.

ID
integer

Message ID.

BLOG_ID
integer

ID of the blog to which the message belongs.

PUBLISH_STATUS
string

Publication status of the message.

TITLE
string

Title of the message.

AUTHOR_ID
integer

ID of the message author.

ENABLE_COMMENTS
string

Are comments allowed?

NUM_COMMENTS
integer

Number of comments.

CODE
string

Symbolic code of the message.

MICRO
string

Indicator of a micro-message.

DETAIL_TEXT
string

Text of the message.

DATE_PUBLISH
datetime

Date and time of publication.

CATEGORY_ID
string

Comma-separated IDs of tags (categories).

HAS_SOCNET_ALL
string

Indicator of publication for all authorized users.

HAS_TAGS
string

Indicator of the presence of tags.

HAS_IMAGES
string

Indicator of the presence of images.

HAS_PROPS
string

Indicator of the presence of custom fields.

HAS_COMMENT_IMAGES
string

Indicator of the presence of images in comments.

UF_*
object

Custom fields of the message. The set of fields depends on the account settings. The format of each field is described below.

UF_BLOG_POST_DOC
object

Additional field with files.

UF_BLOG_POST_URL_PRV
object

Link preview data from the message text, if the preview was successfully generated.

UF_GRATITUDE
object

Service field for the Gratitude functionality.

UF_BLOG_POST_FILE
object

Drive files attached to the message.

UF_BLOG_POST_IMPRTNT
object

Indicator of an important message.

UF_IMPRTANT_DATE_END
object

Date and time until which the message is considered important.

UF_BLOG_POST_VOTE
object

Poll data if a poll is attached to the message.

UF_MAIL_MESSAGE
object

Connection of the message with email.

FILES
array

Array of file IDs from UF_BLOG_POST_FILE.

next
integer

Value for pagination (if available).

total
integer

Total number of found items.

time
time

Information about the execution time of the request.

Object UF_*

Name
type

Description

ID
integer

ID of the custom field.

ENTITY_ID
string

Object of the field.

FIELD_NAME
string

Code of the custom field.

USER_TYPE_ID
string

Type of the custom field.

XML_ID
string

External code of the field.

SORT
integer

Sort order of the field.

MULTIPLE
string

Indicator of a multiple field.

MANDATORY
string

Indicator of mandatory.

SHOW_FILTER
string

Indicator of displaying the field in the filter.

SHOW_IN_LIST
string

Indicator of displaying the field in lists.

EDIT_IN_LIST
string

Indicator of editing the field in lists.

IS_SEARCHABLE
string

Indicator of the field's participation in search.

SETTINGS
object

Field settings depending on the type.

EDIT_FORM_LABEL
string

Label of the field in the edit form.

LIST_COLUMN_LABEL
string

Label of the field in list columns.

LIST_FILTER_LABEL
string

Label of the field in the filter.

ERROR_MESSAGE
string

Error message of the field.

HELP_MESSAGE
string

Help message for the field.

USER_TYPE
object

Description of the custom field type.

VALUE
string

Value of the field.

ENTITY_VALUE_ID
integer

ID of the message to which the field value belongs.

VALUE_EXISTS
boolean

Indicator of the presence of the field value.

VALUE_RAW
string

Raw value of the field.

CUSTOM_DATA
object

Additional data of the field.

Object USER_TYPE

Name
type

Description

USER_TYPE_ID
string

Identifier of the custom field type.

CLASS_NAME
string

PHP class of the field type handler.

EDIT_CALLBACK
array

Handler that forms the edit interface of the field.

VIEW_CALLBACK
array

Handler that forms the display of the field in the view interface.

USE_FIELD_COMPONENT
boolean

Indicator of using the standard field component.

DESCRIPTION
string

Name of the field type.

BASE_TYPE
string

Base type of the value.

TAG
array

Additional tags of the field type.

Error Handling

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

Previous
Edit Message
Next
Delete Message