Получить свойство

GET /v1/catalog-product-properties/:id

Возвращает одно свойство товаров каталога по идентификатору. Ответ содержит полный набор полей: кроме id, name и propertyType приходят символьный код, настройки списка, настройки пользовательского типа и привязки.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор свойства

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-product-properties/659" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-product-properties/659" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-product-properties/659', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Свойство:', data.name)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-product-properties/659', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект свойства. Базовый набор полей — см. Поля свойства

Дополнительно к полям справочника одна запись содержит:

  • code — символьный код
  • sort — порядок сортировки
  • propertyType — базовый тип значения
  • listType — внешний вид списка
  • multiple — признак множественного значения
  • userType — пользовательский тип
  • userTypeSettings — настройки пользовательского типа
  • linkIblockId — идентификатор привязанного каталога

Поля с пустым значением приходят как null.

Пример ответа

Показаны основные поля.

JSON 
{
  "success": true,
  "data": {
    "id": 659,
    "iblockId": 19,
    "name": "Рубрика",
    "active": true,
    "code": "s12",
    "propertyType": "S",
    "listType": "L",
    "multiple": false,
    "multipleCnt": null,
    "rowCount": 1,
    "colCount": 30,
    "isRequired": false,
    "searchable": false,
    "filtrable": false,
    "withDescription": null,
    "defaultValue": null,
    "linkIblockId": null,
    "fileType": null,
    "sort": null,
    "userType": "directory",
    "userTypeSettings": {
      "group": "N",
      "multiple": "N",
      "size": 1,
      "tableName": "b_hlbd_categories",
      "width": 0
    },
    "hint": null,
    "xmlId": null,
    "timestampX": "2026-03-19T18:23:02.000Z"
  }
}

Пример ответа при ошибке

404 — свойства с таким id нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "catalog product property not found"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Свойства с указанным id не существует
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key

Полный список общих ошибок API — Ошибки.

Смотрите также