Get Information Block Element iblock.element.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: iblock

Who can execute the method: any user

The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The method iblock.element.get returns an information block element by identifier.

The method works only with information blocks that have an "API symbolic code" set and the "Access via REST is enabled" option selected in the admin panel. Cloud Bitrix24 has no admin panel, so these settings cannot be set and the method returns an error. For details, see the section limitations and specifics.

Method Parameters

Required parameters are marked with *

Name
type

Description

iblock*
integer

Identifier of the information block that contains the element. The value must be greater than 0.

Note that the parameter is named iblock, not iblockId. In information block validation errors, the field is named iblockId

id*
integer

Element identifier.

The identifier can be retrieved using the iblock.element.list method

select
array

Array of element fields to return in the response.

Available fields:

  • id — element identifier
  • iblockId — information block identifier
  • name — element name
  • iblockSectionId — information block section identifier
  • properties — element property values

Default: id, iblockId, name, iblockSectionId. Without select, the properties field is returned only if the element has filled properties

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/iblock.element.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"iblock":14,"id":215,"select":["id","name","iblockSectionId","properties"]}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/iblock.element.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"iblock":14,"id":215,"select":["id","name","iblockSectionId","properties"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/iblock.element.get
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type PropertyValue = {
          id: number
          value: string
          description: string | null
        }
        
        type ElementGetResult = {
          item: {
            id: number
            name: string
            iblockSectionId: number | null
            properties: Record<string, PropertyValue | PropertyValue[]>
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<ElementGetResult>({
            method: 'iblock.element.get',
            params: {
              iblock: 14,
              id: 215,
              select: ['id', 'name', 'iblockSectionId', 'properties'],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info(result.item.name, result.item.properties)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getElement() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'iblock.element.get',
                params: {
                  iblock: 14,
                  id: 215,
                  select: ['id', 'name', 'iblockSectionId', 'properties'],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info(result.item.name, result.item.properties)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getElement)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.iblock.element.get(
                iblock=14,
                id=215,
                select=["id", "name", "iblockSectionId", "properties"],
            ).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}")
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'iblock.element.get',
                    [
                        'iblock' => 14,
                        'id' => 215,
                        'select' => ['id', 'name', 'iblockSectionId', 'properties'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

BX24.callMethod(
            'iblock.element.get',
            {
                iblock: 14,
                id: 215,
                select: ['id', 'name', 'iblockSectionId', 'properties'],
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'iblock.element.get',
            [
                'iblock' => 14,
                'id' => 215,
                'select' => ['id', 'name', 'iblockSectionId', 'properties'],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "iblock.element.get", b24.Params{
        	"iblock": 14,
        	"id":     215,
        	"select": []string{"id", "name", "iblockSectionId", "properties"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("iblock.element.get: %w", err)
        }
        
        // The method wraps the response in an object with the "item" key.
        raw, ok := b24.Unwrap(res.Result, "item")
        if !ok {
        	return fmt.Errorf("no item key in the response")
        }
        
        var item struct {
        	ID              int                        `json:"id"`
        	Name            string                     `json:"name"`
        	IblockSectionID *int                       `json:"iblockSectionId"`
        	Properties      map[string]json.RawMessage `json:"properties"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name, len(item.Properties))
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 215,
                    "name": "Office chair",
                    "iblockSectionId": 8,
                    "properties": {
                        "COLOR": {
                            "id": 1043,
                            "value": "Black",
                            "description": null
                        },
                        "SIZE": [
                            {
                                "id": 1044,
                                "value": "M",
                                "description": null
                            },
                            {
                                "id": 1045,
                                "value": "L",
                                "description": null
                            }
                        ]
                    }
                }
            },
            "time": {
                "start": 1792670785,
                "finish": 1792670785.424705,
                "duration": 0.42470502853393555,
                "processing": 0,
                "date_start": "2026-10-22T15:06:25+02:00",
                "date_finish": "2026-10-22T15:06:25+02:00",
                "operating_reset_at": 1792671360,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with the response data

result.item
object

Information block element. The set of fields depends on select. Field description

time
time

Information about the request execution time

Item Object

Name
type

Description

id
integer

Element identifier

iblockId
integer

Information block identifier

name
string

Element name

iblockSectionId
integer

Information block section identifier. null if the element is not linked to a section

properties
object

Element property values. The key is the property symbolic code, the value is a value object for a single property or an array of such objects for a multiple property.

If properties is specified in select but the element has no properties, an empty array [] is returned

Property Value Object

Name
type

Description

id
integer

Property value identifier

value
string

Property value

description
string

Value description. null if no description is set

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "Unable to compile iblock entity.",
                        "field": "iblockId"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

iblock

Required field iblock is missing

Pass the information block identifier in the iblock parameter

iblock

Field value must be 1 or greater

Pass a positive information block identifier

id

Required field id is missing

Pass the element identifier

iblockId

Iblock not found.

There is no information block with this identifier. Check the iblock value

iblockId

Unable to compile iblock entity.

The information block has no API code. Set it in the admin panel. This is not possible in cloud Bitrix24

iblockId

Restricted iblock ID:#ID# (#API_CODE#)

REST access is disabled for the information block. Enable it in the admin panel

Object Not Found Error

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field

Error description

How to Fix

-

Entity with ID #ID# was not found

There is no element with this identifier in the information block. Check id and iblock

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

select

Unknown field #FIELD# found in entity ElementDto

Specify only the fields from the item object description

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