properties configured for the catalog in your Bitrix24 account."> properties configured for the catalog in your Bitrix24 account."> properties configured for the catalog in your Bitrix24 account.">

For AI agents: markdown of this page — /docs-content-en/entities/products/get.md documentation index — /llms.txt

Get product

GET /v1/products/:id

Returns a single CRM catalog product by identifier. The response includes the product's basic fields and the custom PROPERTY_<N> properties configured for the catalog in your Bitrix24 account.

Parameters

Parameter Type Required Description
id (path) number yes Product identifier. List: GET /v1/products

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/products/6967" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth app

Terminal 
curl "https://vibecode.bitrix24.com/v1/products/6967" \
  -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/products/6967', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Product:', data.name, '—', data.price, data.currency)

JavaScript — OAuth app

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/products/6967', {
  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 Product object: basic fields — see Product fields, plus the custom PROPERTY_<N> properties

The basic fields match the array element in GET /v1/products. Additionally, properties of the form PROPERTY_<N> come back — one key per catalog property. If a value is not filled in, the key is returned with a null value.

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 6967,
    "name": "Master product",
    "code": "product_sku",
    "active": true,
    "previewPicture": null,
    "detailPicture": null,
    "sort": 100,
    "xmlId": "6967",
    "updatedAt": "2025-05-12T09:05:27.000Z",
    "createdAt": "2025-05-12T09:03:15.000Z",
    "modifyBy": 1,
    "createdBy": 1,
    "catalogId": 25,
    "sectionId": null,
    "description": null,
    "descriptionType": "text",
    "price": 100,
    "currency": "USD",
    "vatId": null,
    "vatIncluded": false,
    "measure": null,
    "PROPERTY_309": null,
    "PROPERTY_295": null,
    "PROPERTY_297": null
  }
}

Error response example

404 — product not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Product is not found."
  }
}

Errors

HTTP Code Description
404 ENTITY_NOT_FOUND A product with this id was not found
403 SCOPE_DENIED API key does not have the crm scope
401 MISSING_API_KEY The X-Api-Key header was not passed

Full list of common API errors — Errors.

Known specifics

The property set is the same within a catalog. The set of PROPERTY_<N> keys is determined by the catalog settings in your Bitrix24 account — it is identical for all products in the same catalog.

See also