Get Product Fields by Filter v 3.0 catalog.product.fields.getbyfilter
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", "View catalog products", or "Edit selling price" access permission
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.product.fields.getbyfilter returns the description of the fields of a simple product in the specified trade catalog, including the catalog properties.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
filter* |
Object with the catalog identifier. Parameter description. The method does not accept an array of conditions in the REST 3.0 format |
Parameter filter
Required parameters are marked with *
|
Name |
Description |
|
iblockId* |
Identifier of the product trade catalog. The key can also be passed as The identifier can be retrieved using the catalog.catalog.list method. For an offers catalog, the method returns an error |
The method always returns the fields of a simple product. The product type from the filter is ignored.
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.product.fields.getbyfilter
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"iblockId":25}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.fields.getbyfilter
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"iblockId":25},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.product.fields.getbyfilter
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type ProductFieldsResult = {
fields: Record<string, {
TYPE: string
IS_REQUIRED: boolean
IS_READ_ONLY: boolean
IS_IMMUTABLE: boolean
NAME: string
IS_DYNAMIC?: boolean
IS_MULTIPLE?: boolean
PROPERTY_TYPE?: string
USER_TYPE?: string | null
}>
}
try {
const response = await $b24.actions.v3.call.make<ProductFieldsResult>({
method: 'catalog.product.fields.getbyfilter',
params: {
filter: {
iblockId: 25,
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Fields:', Object.keys(result.fields))
}
} 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 getProductFields() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.product.fields.getbyfilter',
params: {
filter: {
iblockId: 25,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Fields:', Object.keys(result.fields))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getProductFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product.fields.getbyfilter(
filter={
"iblockId": 25,
},
).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.product.fields.getbyfilter',
[
'filter' => [
'iblockId' => 25,
],
]
);
$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.product.fields.getbyfilter',
{
filter: {
iblockId: 25,
},
},
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.product.fields.getbyfilter',
[
'filter' => [
'iblockId' => 25,
],
]
);
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.product.fields.getbyfilter", b24.Params{
"filter": b24.Params{
"iblockId": 25,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.product.fields.getbyfilter: %w", err)
}
var result struct {
Fields map[string]struct {
Type string `json:"TYPE"`
IsRequired bool `json:"IS_REQUIRED"`
Name string `json:"NAME"`
} `json:"fields"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for code, field := range result.Fields {
fmt.Println(code, field.Type, field.IsRequired)
}
Response Handling
HTTP status: 200
The method returns the description of all product fields and catalog properties. The example shows some of the fields.
{
"result": {
"fields": {
"ID": {
"TYPE": "integer",
"IS_REQUIRED": false,
"IS_READ_ONLY": true,
"IS_IMMUTABLE": false,
"NAME": "ID"
},
"NAME": {
"TYPE": "string",
"IS_REQUIRED": true,
"IS_READ_ONLY": false,
"IS_IMMUTABLE": false,
"NAME": "Name"
},
"IBLOCK_ID": {
"TYPE": "integer",
"IS_REQUIRED": true,
"IS_READ_ONLY": false,
"IS_IMMUTABLE": true,
"NAME": "Information block ID"
},
"PREVIEW_PICTURE": {
"TYPE": "file",
"IS_REQUIRED": false,
"IS_READ_ONLY": false,
"IS_IMMUTABLE": false,
"NAME": "Preview image"
},
"PROPERTY_301": {
"TYPE": "productproperty",
"IS_REQUIRED": false,
"IS_READ_ONLY": false,
"IS_IMMUTABLE": false,
"NAME": "SKU code",
"IS_DYNAMIC": true,
"IS_MULTIPLE": false,
"PROPERTY_TYPE": "S",
"USER_TYPE": ""
},
"PROPERTY_305": {
"TYPE": "productproperty",
"IS_REQUIRED": false,
"IS_READ_ONLY": false,
"IS_IMMUTABLE": false,
"NAME": "Material",
"IS_DYNAMIC": true,
"IS_MULTIPLE": true,
"PROPERTY_TYPE": "S",
"USER_TYPE": null
},
"TYPE": {
"TYPE": "integer",
"IS_REQUIRED": false,
"IS_READ_ONLY": true,
"IS_IMMUTABLE": false,
"NAME": "Product type"
},
"QUANTITY": {
"TYPE": "double",
"IS_REQUIRED": false,
"IS_READ_ONLY": false,
"IS_IMMUTABLE": false,
"NAME": "Quantity in stock"
},
"VAT_ID": {
"TYPE": "integer",
"IS_REQUIRED": false,
"IS_READ_ONLY": false,
"IS_IMMUTABLE": false,
"NAME": "Tax ID"
},
"MEASURE": {
"TYPE": "integer",
"IS_REQUIRED": false,
"IS_READ_ONLY": false,
"IS_IMMUTABLE": false,
"NAME": "Unit of measurement"
}
}
},
"time": {
"start": 1792660854,
"finish": 1792660854.262779,
"duration": 0.26277899742126465,
"processing": 0,
"date_start": "2026-10-22T12:20:54+02:00",
"date_finish": "2026-10-22T12:20:54+02:00",
"operating_reset_at": 1792661400,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the response data |
|
result.fields |
Field descriptions. The key is the field code in uppercase, for example |
|
time |
Information about the request execution time |
Field Description
|
Name |
Description |
|
TYPE |
Field type: |
|
IS_REQUIRED |
|
|
IS_READ_ONLY |
|
|
IS_IMMUTABLE |
|
|
NAME |
Field name |
|
IS_DYNAMIC |
Properties only. |
|
IS_MULTIPLE |
Properties only. |
|
PROPERTY_TYPE |
Properties only. Basic type of the property:
|
|
USER_TYPE |
Properties only. User type of the property, for example |
Field codes are returned in the format of the previous API version, and their set does not match the REST 3.0 fields. Product fields for REST 3.0 methods are returned by catalog.product.field.list. Pass the PROPERTY_{id} property keys from the response in the properties field of the catalog.product.add and catalog.product.update methods.
In the previous API version, each product type has its own method: catalog.product.getFieldsByFilter, catalog.product.sku.getFieldsByFilter, catalog.product.offer.getFieldsByFilter, and catalog.product.service.getFieldsByFilter. They return fields in an object named after the type, for example result.product or result.service, with keys in the iblockId format and the isRequired, isReadOnly, and isImmutable flags. In REST 3.0, there is one method, and it returns only the fields of a simple product.
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error validating request object.",
"validation": [
{
"message": "productType is not allowed for this catalog"
}
]
}
}
|
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 the |
|
|
Incorrect filter format |
Pass the |
|
|
parameter - iblockId is empty |
Pass |
|
|
iblock is not catalog |
The information block is not a trade catalog. Pass the trade catalog identifier |
|
|
productType is not allowed for this catalog |
Pass the identifier of the product catalog, not the offers catalog |
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 to view the catalog |
Method Name Error
Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION
HTTP status: 404
|
Field |
Error description |
How to Fix |
|
|
Method |
Call the method in lowercase: |
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 |