Для AI-агентов: markdown этой страницы — /docs-content/entities/catalog-services/get.md индекс документации — /llms.txt

Получить услугу

GET /v1/catalog-services/:id

Возвращает одну услугу каталога по идентификатору вместе с разделами каталога и свойствами каталога.

Ответ содержит больше полей, чем список: кроме сокращённого набора приходят символьный код, внешний код, сортировка, ставка НДС, тексты, картинки и свойства каталога вида propertyNNN.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор услуги. Список: GET /v1/catalog-services

Примеры

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

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

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

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

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

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

const { success, data } = await res.json()
console.log('Услуга:', data.name, 'раздел:', data.iblockSectionId)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект услуги. Все поля — см. Поля услуги

Сверх полей, которые возвращает список, одна запись содержит:

  • code — символьный код
  • xmlId — внешний код. Если он не задан при создании, приходит id услуги строкой
  • sort — порядок сортировки
  • vatId — ID ставки НДС. Список: GET /v1/catalog-vat-rates
  • previewText, detailText, previewTextType, detailTextType — тексты и их формат
  • previewPicture, detailPicture — картинки
  • iblockSection — массив ID всех разделов каталога, к которым относится услуга
  • свойства каталога вида propertyNNN, где NNN — id свойства из GET /v1/catalog-product-properties. Пустое свойство приходит как null, заполненное строковое — объектом { value, valueId }

Поля с пустым значением приходят как null.

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

Показаны основные поля.

JSON 
{
  "success": true,
  "data": {
    "id": 7233,
    "iblockId": 25,
    "iblockSectionId": 281,
    "iblockSection": [281],
    "name": "Чистка кондиционера",
    "type": 7,
    "active": true,
    "available": false,
    "code": "cleaning",
    "xmlId": "7233",
    "sort": 200,
    "measure": 9,
    "vatId": null,
    "vatIncluded": true,
    "previewText": "Чистка фильтров и теплообменника",
    "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"
  }
}

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

404 — услуги с таким id нет:

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

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Записи с указанным id нет (service does not exist.)
404 ENTITY_NOT_FOUND Запись с указанным id есть, но это не услуга — например, обычный товар каталога (catalogService <id> not found)
400 INVALID_PARAMS id не является целым неотрицательным числом (id must be a non-negative integer)
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key

Полный список общих ошибок API — Ошибки.

Известные особенности

iblockSection приходит только в ответе одной записи. Массив разделов услуги есть в ответе GET /v1/catalog-services/:id, а в select списка и поиска это имя отклоняется с 400 SELECT_FIELD_NOT_RETURNED. В списке основной раздел читается из iblockSectionId.

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