Поиск сайтов

POST /v1/sites/search

Поиск сайтов с фильтрацией и авто-пагинацией. Аналогичен GET /v1/sites с фильтрами, но через POST — удобнее для сложных запросов с большим количеством условий.

Поля запроса (body)

Фильтр по типу и область (scope). Битрикс24 привязывает filter.type к текущей области — в области по умолчанию доступны только PAGE / STORE / SMN / VIBE. Если фильтруете {"filter": {"type": "KNOWLEDGE"}} или "GROUP" и не передали scope, Вайбкод сам подставит соответствующую область (type=KNOWLEDGE → scope=KNOWLEDGE), и поиск вернёт именно базы знаний / страницы групп. Явный scope в приоритете. Если тип задан списком/оператором ({"type": {"$in": ["KNOWLEDGE", "PAGE"]}}), где одну область выбрать нельзя, в meta.warnings придёт подсказка с кодом TYPE_REQUIRES_SCOPE. MAINPAGE — область, а не тип сайта (её сайты имеют тип VIBE), поэтому из фильтра не выводится.

Примеры

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

curl -X POST "https://vibecode.bitrix24.tech/v1/sites/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "type": "PAGE", "active": true },
    "limit": 10,
    "select": ["id", "title", "type", "active"]
  }'

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

curl -X POST "https://vibecode.bitrix24.tech/v1/sites/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "type": "PAGE", "active": true },
    "limit": 10,
    "select": ["id", "title", "type", "active"]
  }'

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/sites/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { type: 'PAGE', active: true },
    limit: 10,
    select: ['id', 'title', 'type', 'active'],
  }),
})

const { success, data, meta } = await res.json()
console.log('Получено:', data.length)

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/sites/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { type: 'PAGE', active: true },
    limit: 10,
    select: ['id', 'title', 'type', 'active'],
  }),
})

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

Поля ответа

Поля meta лежат рядом с data, а не внутри него. Обходить страницы нужно по meta.hasMore: длина data, равная limit, последней страницы не исключает.

URL любого сайта из массива data — его id:

https://<portal>.bitrix24.ru/sites/site/<id>/

<portal> — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

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

{
  "success": true,
  "data": [
    {
      "id": 157,
      "title": "Промо-лендинг",
      "code": "/promo/",
      "type": "PAGE",
      "active": true,
      "domainId": 5,
      "createdById": 1,
      "dateCreate": "12.09.2024 10:23:14",
      "dateModify": "04.11.2025 08:51:20"
    }
  ],
  "meta": {
    "total": 10,
    "hasMore": false,
    "durationMs": 99
  }
}

С фильтром по диапазону дат шире 14 дней в meta дополнительно приходят autoWindowed, windowCount и batchWaves:

{
  "success": true,
  "data": [ /* ... */ ],
  "meta": {
    "total": 2,
    "hasMore": false,
    "autoWindowed": true,
    "windowCount": 339,
    "batchWaves": 4,
    "durationMs": 3136
  }
}

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

403 — нет скоупа:

{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'landing' scope"
  }
}

Ошибки

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

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

Разбиение по временны́м окнам. Фильтр по диапазону дат шире 14 дней автоматически разбивается на недельные окна, которые выполняются параллельными волнами — так выборка обходит потолок в 5000 записей на один вызов. В meta тогда приходят autoWindowed: true, число окон windowCount и число волн batchWaves. Отключает разбиение параметр autoWindow: false. При активном разбиении offset больше нуля отклоняется с UNSTABLE_OFFSET_PAGINATION.

Видимость по правам пользователя. Поиск возвращает только те сайты, к которым у владельца API-ключа есть право «просмотр». Если ожидается результат, но data пустой — проверьте права пользователя.

Удалённые сайты. По умолчанию исключаются. Чтобы включить их в результат, передайте {"filter": {"deleted": "Y"}}. Значения — Y или N.

Постраничный переход через offset поддерживается. Вайбкод возвращает запрошенное окно [offset, offset + limit). Если ключ meta.total присутствует, он содержит точное число записей под фильтром. При поиске по временным окнам счётчик возвращается только после полного успешного обхода с удалением повторов; при ранней остановке по limit или неполной выдаче окон ключ отсутствует. Дополнительный обход только ради счётчика не выполняется. Количество возвращённых записей — data.length, а meta.hasMore показывает, есть ли записи за пределами окна.

Сортировка. Поле sort в теле: {"sort": "-id"} — по убыванию, {"sort": "id"} — по возрастанию (принимается и алиас order). Без параметра — по возрастанию id.

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

• Список сайтов
• Получить сайт
• Синтаксис фильтрации
• Batch
• Лимиты и оптимизация