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

List services

GET /v1/catalog-services

Returns the services of a product catalog with support for filtering, sorting, field selection, and pagination.

Requires the filter[iblockId] filter — the product catalog ID. Without this filter, the request is rejected with 400.

Parameters

Parameter Type Required Default Description
filter object yes — Filtering by the fields of GET /v1/catalog-services/fields. The filter[iblockId] key is required — the product catalog ID from GET /v1/catalogs; this catalog has an empty productIblockId. filter[iblockSectionId] with an ID from GET /v1/catalog-sections selects the services of one section.
Filtering syntax. Example: ?filter[iblockId]=25&filter[iblockSectionId]=281
select string no — Comma-separated field selection: ?select=iblockId,id,name,code,sort. If the parameter is passed, it must include iblockId and id. Without select, the response carries a reduced set of fields: the symbolic code, external code, sort order, VAT rate, texts, images, and catalog properties are returned only when listed explicitly — Service fields lists which ones. A catalog property is requested by its own name: ?select=iblockId,id,name,property301
sort string no — Sort field. The - prefix means descending: ?sort=-id
limit number no 50 Number of records (up to 5000)
offset number no 0 Offset from the start of the selection

For limit > 50, the response is automatically assembled from several pages on the server side. The maximum is 5000 records per call. If more records match the filter than were returned, meta.hasMore is true.

Examples

curl — personal key

Terminal
curl -g "https://vibecode.bitrix24.com/v1/catalog-services?filter[iblockId]=25&filter[iblockSectionId]=281&limit=10" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal
curl -g "https://vibecode.bitrix24.com/v1/catalog-services?filter[iblockId]=25&filter[iblockSectionId]=281&limit=10" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript
const params = new URLSearchParams({
  'filter[iblockId]': '25',
  'filter[iblockSectionId]': '281',
  limit: '10',
})
const res = await fetch(`https://vibecode.bitrix24.com/v1/catalog-services?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

JavaScript — OAuth application

javascript
const params = new URLSearchParams({
  'filter[iblockId]': '25',
  'filter[iblockSectionId]': '281',
  limit: '10',
})
const res = await fetch(`https://vibecode.bitrix24.com/v1/catalog-services?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

Field Type Description
success boolean Always true on success
data array Array of services. For the fields of each item, see Service fields
meta.total number Total number of records matching the filter
meta.hasMore boolean Whether there are more records beyond limit

Response example

JSON
{
  "success": true,
  "data": [
    {
      "active": true,
      "available": false,
      "bundle": false,
      "createdBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T20:50:59.000Z",
      "iblockId": 25,
      "iblockSectionId": 281,
      "id": 7231,
      "measure": 9,
      "modifiedBy": 1295,
      "name": "Air conditioner installation",
      "timestampX": "2026-10-08T20:50:59.000Z",
      "type": 7,
      "vatIncluded": true
    },
    {
      "active": true,
      "available": false,
      "bundle": false,
      "createdBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T20:51:00.000Z",
      "iblockId": 25,
      "iblockSectionId": 281,
      "id": 7233,
      "measure": 9,
      "modifiedBy": 1295,
      "name": "Air conditioner cleaning",
      "timestampX": "2026-10-08T20:51:00.000Z",
      "type": 7,
      "vatIncluded": true
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false
  }
}

Error response example

400 — the required filter was not passed:

JSON
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FILTER",
    "message": "GET /v1/catalog-services requires filter fields: iblockId. Example: GET /v1/catalog-services?filter[iblockId]=..."
  }
}

Errors

HTTP Code Description
400 MISSING_REQUIRED_FILTER The required filter[iblockId] filter was not passed. The request is rejected before Bitrix24 is called — the message contains the name of the missing field and a call example
400 UNKNOWN_FILTER_FIELD Filtering by a field the service does not have. The message contains the list of available fields
400 UNKNOWN_SORT_FIELD Sorting by a field the service does not have. The message contains the list of available fields
400 UNKNOWN_SELECT_FIELD select contains a name the service does not have. The message contains the list of available fields
400 SELECT_FIELD_NOT_RETURNED select contains iblockSection — this name is not supported in the selection. The main section is returned in iblockSectionId
422 BITRIX_ERROR select does not include iblockId (Required select fields: iblockId)
422 BITRIX_ERROR select does not include id (Required select fields: id)
422 BITRIX_ERROR filter[iblockId] holds the ID of an offer catalog, not a product catalog (productType is not allowed for this catalog)
422 BITRIX_ERROR There is no catalog with the specified iblockId (iblock is not catalog)
403 SCOPE_DENIED The API key does not have the catalog scope
401 MISSING_API_KEY The X-Api-Key header was not passed
429 RATE_LIMITED Rate limit exceeded: 300 requests per minute per portal, all API keys of the portal share one limit. The exact value arrives in the x-ratelimit-limit header (the cap is divided across replicas). Retry after the delay in the Retry-After header

Full list of common API errors — Errors.

Known specifics

A type filter does not change the result set. The response contains only services, each with type equal to 7. A request with filter[type]=1 returns the same set of services as without this filter — regular catalog products cannot be read through this endpoint.

See also