## Search product properties

`POST /v1/catalog-product-properties/search`

Search catalog product property definitions by the conditions passed in the request body.

Unlike [`GET /v1/catalog-product-properties`](./list.md), the `filter`, `select`, `sort`, `limit`, and `offset` parameters are passed in the JSON body rather than in the address string — this is more convenient for conditions across several fields. Like the list, search accepts `filter.iblockId` to scope the selection to one catalog. The response format is the same as the list.

## Request fields (body)

| Parameter | Type | Req. | Default | Description |
|----------|-----|:-----:|-----------|---------|
| `filter` | object | no | — | Filtering conditions. The `iblockId` key scopes the selection to one catalog — the catalog ID from [`GET /v1/catalogs`](/docs/entities/catalogs).<br>[Filtering syntax](/docs/filtering). Example: `{ "iblockId": 19, "active": true }` |
| `select` | string[] | no | — | Field selection: `["id", "name", "propertyType"]`. Without `select`, all property fields are returned |
| `sort` | string | no | — | Sort field. The `-` prefix means descending: `"-id"` |
| `limit` | number | no | `50` | Number of records (up to 5000) |
| `offset` | number | no | `0` | Offset from the start of the selection. Together with a date-range filter wider than 14 days it is rejected — see `UNSTABLE_OFFSET_PAGINATION` in the "Errors" section |
| `autoWindow` | boolean | no | `true` | Split the result set into weekly windows when filtering by a date range wider than 14 days. `false` disables splitting |

## Examples

### curl — personal key

```bash
curl -X POST "https://vibecode.bitrix24.com/v1/catalog-product-properties/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 19, "active": true },
    "limit": 3
  }'
```

### curl — OAuth application

```bash
curl -X POST "https://vibecode.bitrix24.com/v1/catalog-product-properties/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 19, "active": true },
    "limit": 3
  }'
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-product-properties/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 19, active: true },
    limit: 3,
  }),
})

const { success, data, meta } = await res.json()
console.log(`Found: ${meta.total}`)
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-product-properties/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 19, active: true },
    limit: 3,
  }),
})

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

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | array | Array of property definitions. The field set of an element — see [Property fields](./fields.md) |
| `meta.total` | number | Total number of records matching the filter |
| `meta.hasMore` | boolean | Whether there are more records beyond `limit` |
| `meta.durationMs` | number | Request execution time in milliseconds |
| `meta.autoWindowed` | boolean | `true` if the result set was split into time windows |
| `meta.windowCount` | number | Number of windows. Present with `autoWindowed: true` |
| `meta.batchWaves` | number | Number of parallel request waves. Present with `autoWindowed: true` |

The `meta` fields sit next to `data`, not inside it. Pages must be walked by `meta.hasMore`: a `data` length equal to `limit` does not rule out the last page.

The `id` of each definition from the `data` array is the `NNN` in the `propertyNNN` key on [Catalog products](/docs/entities/catalog-products) elements:

```
propertyNNN  →  property with id = NNN
```

This correspondence builds the `id` → `name` map used to label `propertyNNN` values. Access is restricted by the employee's permissions in Bitrix24.

## Response example

```json
{
  "success": true,
  "data": [
    {
      "id": 152,
      "iblockId": 19,
      "name": "Needle length",
      "propertyType": "L",
      "code": "FEATURES",
      "active": true,
      "sort": 100,
      "defaultValue": null,
      "userType": null,
      "userTypeSettings": null,
      "listType": "L",
      "multiple": true,
      "multipleCnt": null,
      "rowCount": 1,
      "colCount": 30,
      "withDescription": null,
      "searchable": false,
      "filtrable": false,
      "isRequired": false,
      "linkIblockId": null,
      "fileType": null,
      "xmlId": null,
      "hint": null,
      "timestampX": "2026-03-19T18:23:02.000Z"
    },
    {
      "id": 154,
      "iblockId": 19,
      "name": "RU registration name",
      "propertyType": "S",
      "code": "NAME_RU",
      "active": true,
      "sort": 110,
      "defaultValue": null,
      "userType": null,
      "userTypeSettings": null,
      "listType": "L",
      "multiple": false,
      "multipleCnt": null,
      "rowCount": 1,
      "colCount": 30,
      "withDescription": null,
      "searchable": false,
      "filtrable": false,
      "isRequired": false,
      "linkIblockId": null,
      "fileType": null,
      "xmlId": null,
      "hint": null,
      "timestampX": "2026-03-19T18:23:02.000Z"
    }
  ],
  "meta": {
    "total": 12,
    "hasMore": false,
    "durationMs": 540
  }
}
```

With a date-range filter wider than 14 days, `meta` additionally returns `autoWindowed`, `windowCount`, and `batchWaves`:

```json
{
  "success": true,
  "data": [ /* ... */ ],
  "meta": {
    "total": 5,
    "hasMore": true,
    "autoWindowed": true,
    "windowCount": 131,
    "batchWaves": 3,
    "durationMs": 1131
  }
}
```

## Error response example

400 — filtering by a field the property does not have:

```json
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `UNKNOWN_FILTER_FIELD` | Filtering by a field the property does not have. The message contains the list of available fields |
| 400 | `UNKNOWN_SORT_FIELD` | Sorting by a field the property does not have. The message contains the list of available fields |
| 400 | `UNSTABLE_OFFSET_PAGINATION` | `offset` greater than zero together with a date-range filter wider than 14 days. Two different retrieval algorithms produce inconsistent results, so the request is rejected. Take everything in a single request with `limit` up to 5000, or pass `autoWindow: false` with sorting by `id`, or split the date range into parts yourself |
| 403 | `SCOPE_DENIED` | The API key does not have the `catalog` scope |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header was not passed |

Full list of common API errors — [Errors](/docs/errors).

## Known specifics

**Time-window splitting.** A date-range filter wider than 14 days is automatically split into weekly windows executed in parallel waves, so the result set bypasses the ceiling of 5000 records per call. `meta` then returns `autoWindowed: true`, the number of windows `windowCount`, and the number of waves `batchWaves`. The `autoWindow: false` parameter disables splitting. While splitting is active, an `offset` greater than zero is rejected with `UNSTABLE_OFFSET_PAGINATION`.

## See also

- [List properties](/docs/entities/catalog-product-properties/list)
- [Create a property](/docs/entities/catalog-product-properties/create)
- [Get a property](/docs/entities/catalog-product-properties/get)
- [Property fields](/docs/entities/catalog-product-properties/fields)
- [Catalog products](/docs/entities/catalog-products)
- [Filtering syntax](/docs/filtering)
- [Entity reference](/docs/entities-index)