Get a service

GET /v1/catalog-services/:id

Returns a single catalog service by identifier, together with its catalog sections and catalog properties.

The response contains more fields than the list: in addition to the reduced set, it returns the symbolic code, external code, sort order, VAT rate, texts, images, and catalog properties of the form propertyNNN.

Parameters

Examples

curl — personal key

curl "https://vibecode.bitrix24.com/v1/catalog-services/7233" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

curl "https://vibecode.bitrix24.com/v1/catalog-services/7233" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-services/7233', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Service:', data.name, 'section:', data.iblockSectionId)

JavaScript — OAuth application

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

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

Response fields

On top of the fields the list returns, a single record contains:

• code — symbolic code
• xmlId — external code. If it was not set on creation, it contains the service id as a string
• sort — sort order
• vatId — VAT rate ID. List: GET /v1/catalog-vat-rates
• previewText, detailText, previewTextType, detailTextType — texts and their format
• previewPicture, detailPicture — images
• iblockSection — an array of IDs of all catalog sections the service belongs to
• catalog properties of the form propertyNNN, where NNN is the property id from GET /v1/catalog-product-properties. An empty property is returned as null, a filled string property as an object { value, valueId }

Fields with an empty value are returned as null.

Response example

The main fields are shown.

{
  "success": true,
  "data": {
    "id": 7233,
    "iblockId": 25,
    "iblockSectionId": 281,
    "iblockSection": [281],
    "name": "Air conditioner cleaning",
    "type": 7,
    "active": true,
    "available": false,
    "code": "cleaning",
    "xmlId": "7233",
    "sort": 200,
    "measure": 9,
    "vatId": null,
    "vatIncluded": true,
    "previewText": "Filter and heat exchanger cleaning",
    "previewTextType": "text",
    "detailText": null,
    "detailTextType": "text",
    "previewPicture": null,
    "detailPicture": null,
    "property295": "N",
    "property301": null,
    "createdBy": 1295,
    "modifiedBy": 1295,
    "dateCreate": "2026-10-08T20:51:00.000Z",
    "timestampX": "2026-10-08T20:51:00.000Z"
  }
}

Error response example

404 — no service with this id exists:

{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "service does not exist."
  }
}

Errors

Full list of common API errors — Errors.

Known specifics

iblockSection is returned only in the single-record response. The array of the service's sections is present in the GET /v1/catalog-services/:id response, while the list and search reject this name in select with 400 SELECT_FIELD_NOT_RETURNED. In the list, read the main section from iblockSectionId.

See also

• Create a service
• Update a service
• Delete a service
• List services
• Service fields
• Catalog product properties
• API reference