
## Get a property

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

Returns a single catalog product property by identifier. The response contains the full field set: in addition to `id`, `name`, and `propertyType`, it returns the symbolic code, list settings, user-type settings, and bindings.

## Parameters

| Parameter | Type | Req. | Description |
|----------|-----|:-----:|---------|
| `id` (path) | number | yes | Property identifier |

## Examples

### curl — personal key

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

### curl — OAuth application

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

### JavaScript — personal key

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

const { success, data } = await res.json()
console.log('Property:', data.name)
```

### JavaScript — OAuth application

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

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

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | object | Property object. The base field set — see [Property fields](./fields.md) |

In addition to the reference fields, a single record contains:

- `code` — symbolic code
- `sort` — sort order
- `propertyType` — base value type
- `listType` — list appearance
- `multiple` — multiple value flag
- `userType` — user type
- `userTypeSettings` — user-type settings
- `linkIblockId` — linked catalog identifier

Fields with an empty value are returned as `null`.

## Response example

The main fields are shown.

```json
{
  "success": true,
  "data": {
    "id": 659,
    "iblockId": 19,
    "name": "Category",
    "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"
  }
}
```

## Error response example

404 — there is no property with such `id`:

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

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 404 | `ENTITY_NOT_FOUND` | No property with the specified `id` exists |
| 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).

## See also

- [Create a property](/docs/entities/catalog-product-properties/create)
- [Update a property](/docs/entities/catalog-product-properties/update)
- [Delete a property](/docs/entities/catalog-product-properties/delete)
- [List properties](/docs/entities/catalog-product-properties/list)
- [Property fields](/docs/entities/catalog-product-properties/fields)
- [Catalog products](/docs/entities/catalog-products)
- [Entity reference](/docs/entities-index)
