Get Field Values of Catalog Section v 3.0 catalog.section.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:
catalogWho can execute the method: a user with the "View product catalog" or "View catalog products" access permission and permission to read the section in the information block
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 catalog.section.get returns the fields of a trade catalog section by identifier.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Section identifier. The identifier can be retrieved using the catalog.section.list method or when creating a section with the catalog.section.add method. For a non-existent section, the method returns an access error |
|
select |
Array of strings with the names of the section fields to return in the response, for example Available fields:
The value Default: all fields |
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}/catalog.section.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":387,"select":["id","name","iblockSectionId","active"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.section.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":387,"select":["id","name","iblockSectionId","active"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.section.get
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type SectionGetResult = {
item: {
id?: number
name?: string
iblockSectionId?: number
active?: 'Y' | 'N'
}
}
try {
const response = await $b24.actions.v3.call.make<SectionGetResult>({
method: 'catalog.section.get',
params: {
id: 387,
select: [
'id',
'name',
'iblockSectionId',
'active',
],
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Section:', result.item.id, result.item.name)
}
} 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 getSection() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.section.get',
params: {
id: 387,
select: [
'id',
'name',
'iblockSectionId',
'active',
],
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Section:', result.item.id, result.item.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getSection)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
select = [
"id",
"name",
"iblockSectionId",
"active",
]
try:
bitrix_response = client.catalog.section.get(
bitrix_id=387,
select=select,
).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(
'catalog.section.get',
[
'id' => 387,
'select' => [
'id',
'name',
'iblockSectionId',
'active',
],
]
);
$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(
'catalog.section.get',
{
id: 387,
select: [
'id',
'name',
'iblockSectionId',
'active',
],
},
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(
'catalog.section.get',
[
'id' => 387,
'select' => [
'id',
'name',
'iblockSectionId',
'active',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.section.get", b24.Params{
"id": 387,
"select": []string{"id", "name", "iblockSectionId", "active"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.section.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("the response has no item key")
}
var item struct {
ID int `json:"id"`
Name string `json:"name"`
IblockSectionID int `json:"iblockSectionId"`
Active string `json:"active"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.Name, item.IblockSectionID)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 387,
"name": "Bags and Backpacks",
"iblockSectionId": 385,
"active": "N"
}
},
"time": {
"start": 1792665608,
"finish": 1792665608.633603,
"duration": 0.6336030960083008,
"processing": 0,
"date_start": "2026-10-22T13:40:08+02:00",
"date_finish": "2026-10-22T13:40:08+02:00",
"operating_reset_at": 1792666200,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the response data |
|
result.item |
Section fields. The set depends on |
|
time |
Information about the request execution time |
Item Object
The table contains all fields that can be requested in select.
|
Name |
Description |
|
id |
Section identifier |
|
iblockId |
Identifier of the trade catalog information block |
|
name |
Section name |
|
iblockSectionId |
Identifier of the parent section. |
|
active |
Section activity: |
|
code |
Symbolic code of the section. An empty string if the code is not set |
|
xmlId |
External identifier of the section. An empty string if the identifier is not set |
|
sort |
Sort index |
|
description |
Section description. An empty string if the description is not set |
|
descriptionType |
Description format: |
Error Handling
HTTP status: 403
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION",
"message": "Access denied"
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
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 |
|
|
Required field |
Pass |
Errors in the select Parameter
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Pass in |
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Invalid field in |
Pass |
Access Error
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
HTTP status: 403
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Check the user's permissions for the catalog and the section. The error is also returned for a non-existent |
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 |
|
|
|
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 — |
|
|
|
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 |