Get a list of product properties or variations catalog.productProperty.list

Scope: catalog

Who can execute the method: a user with permission to view the catalog

The method catalog.productProperty.list returns a list of product properties and variations based on the filter.

Method Parameters

Required parameters are marked with *

Name `type`	Description
select `array`	An array containing the list of fields to select (see fields of the object catalog_product_property). If the parameter is not provided, all fields will be selected
filter `object`	An object for filtering the selected properties in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Possible values for `field` correspond to the fields of the object catalog_product_property. An additional prefix can be specified for the key to clarify the filter behavior. Possible prefix values: `>=` — greater than or equal to `>` — greater than `<=` — less than or equal to `<` — less than `%` — LIKE, substring search. The `%` symbol in the filter value should not be included `=%` — LIKE, substring search. The `%` symbol should be included in the value `%=` — LIKE (similar to `=%`) `!%` — NOT LIKE, substring search. The `%` symbol in the filter value should not be included `!=%` — NOT LIKE, substring search. The `%` symbol should be included in the value `!%=` — NOT LIKE (similar to `!=%`) `=` — equal, exact match (used by default) `!=` — not equal `!` — not equal If `iblockId` is not provided, the method selects properties from all trade catalogs. If an `iblockId` is provided that is not a catalog, the method will return an empty list
order `object`	An object for sorting the selected properties in the format `{"field_1": "order_1", ... "field_N": "order_N"}`. Possible values for `field` correspond to the fields of the object catalog_product_property. Possible values for `order`: `ASC` — in ascending order `DESC` — in descending order If the parameter is not provided, sorting `id ASC` is applied
start `integer`	The parameter is used to control pagination. The page size of results is always static — 50 records. To select the second page of results, pass the value `50`. To select the third page of results — `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 value `-1` is passed, the response will not include the `total` field

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"select":["id","name","iblockId","propertyType"],"filter":{"iblockId":19},"order":{"id":"ASC"}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productProperty.list

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"select":["id","name","iblockId","propertyType"],"filter":{"iblockId":19},"order":{"id":"ASC"},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/catalog.productProperty.list

try {
            const response = await $b24.callMethod('catalog.productProperty.list', {
                select: ['id', 'name', 'iblockId', 'propertyType'],
                filter: { iblockId: 19 },
                order: { id: 'ASC' }
            });
        
            console.log(response.getData().result);
        } catch (error) {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.productProperty.list',
                    [
                        'select' => ['id', 'name', 'iblockId', 'propertyType'],
                        'filter' => [
                            'iblockId' => 19,
                        ],
                        'order' => ['id' => 'ASC'],
                    ]
                );
        
            print_r($response->getResponseData()->getResult());
        } catch (\Throwable $exception) {
            echo $exception->getMessage();
        }

BX24.callMethod(
            'catalog.productProperty.list',
            {
                select: ['id', 'name', 'iblockId', 'propertyType'],
                filter: {
                    iblockId: 19
                },
                order: { id: 'ASC' }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.productProperty.list',
            [
                'select' => ['id', 'name', 'iblockId', 'propertyType'],
                'filter' => ['iblockId' => 19],
                'order' => ['id' => 'ASC'],
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": {
                "productProperties": [
                    {
                        "iblockId": 19,
                        "id": 115,
                        "name": "Brand",
                        "propertyType": "L"
                    },
                    {
                        "iblockId": 19,
                        "id": 659,
                        "name": "Category",
                        "propertyType": "S"
                    },
                    ... // description for each property
                ]
            },
            "next": 50,
            "total": 51,
            "time": {
                "start": 1773933226,
                "finish": 1773933226.400275,
                "duration": 0.40027499198913574,
                "processing": 0,
                "date_start": "2026-03-19T18:13:46+02:00",
                "date_finish": "2026-03-19T18:13:46+02:00",
                "operating_reset_at": 1773933826,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	The root object of the response
productProperties `catalog_product_property[]`	An array of objects with information about the selected properties
next `integer`	Offset for the next page. The field is returned if there are more records
total `integer`	Total number of records. The field is not returned if the request is made with `start = -1`
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "0",
            "error_description": "Access Denied"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status	Code	Description	Value
`400`	`0`	Access Denied	Insufficient rights to view the catalog
`400`	`100`	Invalid value {`...`} to match with parameter {filter}. Should be value of type array	Invalid data type for the value of the `filter` parameter
`400`	`100`	Invalid value {`...`} to match with parameter {select}. Should be value of type array	Invalid data type for the value of the `select` parameter
`400`	`100`	Invalid value {`...`} to match with parameter {order}. Should be value of type array	Invalid data type for the value of the `order` parameter

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Get Property Field Values

Delete Property

Get a list of product properties or variations catalog.productProperty.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning