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

Search services

POST /v1/catalog-services/search

Searches the services of a product catalog by conditions passed in the request body.

Unlike GET /v1/catalog-services, the filter, select, sort, limit, and offset parameters are passed in the JSON body rather than in the query string — conditions on several fields are set as a nested structure. Like the list, search requires filter.iblockId — without this field, the request returns 400. The response format is the same as for the list.

The dateCreate, timestampX, dateActiveFrom, and dateActiveTo fields are not accepted in filter: the request returns 400 UNKNOWN_FILTER_FIELD before calling Bitrix24. These dates remain available in select and responses.

Request fields (body)

Parameter	Type	Required	Default	Description
Parameter`filter`	Typeobject	Requiredyes	Default—	DescriptionFiltering by the fields of `GET /v1/catalog-services/fields`. The `iblockId` key is required — the product catalog ID from `GET /v1/catalogs`; this catalog has an empty `productIblockId`. `iblockSectionId` with an ID from `GET /v1/catalog-sections` selects the services of one section. Filtering syntax. Example: `{ "iblockId": 25, "iblockSectionId": 281 }`
Parameter`select`	Typestring[]	Requiredno	Default—	DescriptionField selection: `["iblockId", "id", "name", "code"]`. 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
Parameter`sort`	Typestring	Requiredno	Default—	DescriptionSort field. The `-` prefix means descending: `"-id"`
Parameter`limit`	Typenumber	Requiredno	Default`50`	DescriptionNumber of records (up to 5000)
Parameter`offset`	Typenumber	Requiredno	Default`0`	DescriptionOffset from the start of the result set

Examples

curl — personal key

Terminal

curl -X POST "https://vibecode.bitrix24.com/v1/catalog-services/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25, "iblockSectionId": 281 },
    "limit": 10
  }'

curl — OAuth application

Terminal

curl -X POST "https://vibecode.bitrix24.com/v1/catalog-services/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25, "iblockSectionId": 281 },
    "limit": 10
  }'

JavaScript — personal key

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-services/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25, iblockSectionId: 281 },
    limit: 10,
  }),
})

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

JavaScript — OAuth application

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-services/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25, iblockSectionId: 281 },
    limit: 10,
  }),
})

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

Response fields

Field	Type	Description
Field`success`	Typeboolean	DescriptionAlways `true` on success
Field`data`	Typearray	DescriptionArray of services. For the fields of each item, see Service fields
Field`meta.total`	Typenumber	DescriptionHow many records matched the filter
Field`meta.hasMore`	Typeboolean	DescriptionWhether there are more records beyond `limit`
Field`meta.durationMs`	Typenumber	DescriptionRequest duration in milliseconds

The meta fields sit next to data, not inside it. Paginate using meta.hasMore: a data array whose length equals limit can still be the last page.

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,
    "durationMs": 165
  }
}

Error response example

400 — the required filter was not passed: