## Список свойств

`GET /v1/catalog-product-properties`

Возвращает список свойств товаров каталога с поддержкой фильтрации, сортировки, выборки полей и пагинации. Фильтр `filter[iblockId]` ограничивает выборку одним каталогом.

## Параметры

| Параметр | Тип | Обяз. | По умолч. | Описание |
|----------|-----|:-----:|-----------|---------|
| `filter` | object | нет | — | Условия фильтрации. Ключ `filter[iblockId]` ограничивает выборку одним каталогом — ID каталога из [`GET /v1/catalogs`](/docs/entities/catalogs).<br>[Синтаксис фильтрации](/docs/filtering). Пример: `?filter[iblockId]=19&filter[active]=true` |
| `select` | string | нет | — | Выборка полей: `?select=id,name,propertyType`. Без `select` возвращаются все поля свойства |
| `sort` | string | нет | — | Поле сортировки. Префикс `-` — по убыванию: `?sort=-id` |
| `limit` | number | нет | `50` | Количество записей (до 5000) |
| `offset` | number | нет | `0` | Смещение от начала выборки |

Для `limit > 50` ответ автоматически собирается из нескольких страниц на стороне сервера. Максимум — 5000 записей за вызов. Если под фильтр попадает больше записей, чем возвращено, в `meta.hasMore` придёт `true`.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/catalog-product-properties?filter[iblockId]=19&limit=10" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/catalog-product-properties?filter[iblockId]=19&limit=10" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const params = new URLSearchParams({ 'filter[iblockId]': '19', limit: '10' })
const res = await fetch(`https://vibecode.bitrix24.tech/v1/catalog-product-properties?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Свойств: ${meta.total}`)
```

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

```javascript
const params = new URLSearchParams({ 'filter[iblockId]': '19', limit: '10' })
const res = await fetch(`https://vibecode.bitrix24.tech/v1/catalog-product-properties?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив свойств. Состав полей элемента — см. [Поля свойства](./fields.md) |
| `meta.total` | number | Общее количество записей, соответствующих фильтру |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |

Свойства типа `L` (список) у товара из [Товаров каталога](/docs/entities/catalog-products) приходят полями вида `propertyNNN`, где `NNN` — это `id` свойства. Эта выборка превращает `NNN` в название и тип. Построив отображение `id` → `name`, можно подписать значения полей `propertyNNN`:

```
propertyNNN  →  data[i].id === NNN  →  data[i].name, data[i].propertyType
```

Доступ ограничен правами сотрудника в Битрикс24.

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

```json
{
  "success": true,
  "data": [
    {
      "id": 152,
      "iblockId": 19,
      "name": "Характеристики товара",
      "active": true,
      "code": "CHARS",
      "propertyType": "L",
      "listType": "L",
      "multiple": true,
      "sort": 500,
      "userType": null,
      "userTypeSettings": null,
      "isRequired": false,
      "searchable": false,
      "filtrable": false,
      "xmlId": null,
      "timestampX": "2026-03-19T18:23:02.000Z"
    },
    {
      "id": 154,
      "iblockId": 19,
      "name": "Наименование по РУ",
      "active": true,
      "code": "NAME_RU",
      "propertyType": "S",
      "listType": null,
      "multiple": false,
      "sort": 510,
      "userType": null,
      "userTypeSettings": null,
      "isRequired": false,
      "searchable": false,
      "filtrable": false,
      "xmlId": null,
      "timestampX": "2026-03-19T18:23:02.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false
  }
}
```

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

422 — каталог из фильтра не найден:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Iblock Not Found"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 422 | `BITRIX_ERROR` | Каталог из `filter[iblockId]` не найден (`Iblock Not Found`) |
| 400 | `UNKNOWN_FILTER_FIELD` | Фильтр по полю, которого нет у свойства. Сообщение содержит список доступных полей |
| 400 | `UNKNOWN_SORT_FIELD` | Сортировка по полю, которого нет у свойства. Сообщение содержит список доступных полей |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `catalog` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

- [Создать свойство](/docs/entities/catalog-product-properties/create)
- [Получить свойство](/docs/entities/catalog-product-properties/get)
- [Поиск свойств](/docs/entities/catalog-product-properties/search)
- [Поля свойства](/docs/entities/catalog-product-properties/fields)
- [Товары каталога](/docs/entities/catalog-products)
- [Синтаксис фильтрации](/docs/filtering)
- [Справочник API](/docs/api-reference)