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

Список страниц

GET /v1/pages

Возвращает список страниц лендингов и интернет-магазинов с поддержкой фильтрации и автопагинации. По умолчанию возвращаются только не удалённые страницы.

Параметры

Параметр Тип По умолч. Описание
limit number 50 Количество записей (до 5000)
offset number 0 Пропустить N записей
select string — Выборка полей: ?select=id,title,code,siteId,active. Без select ответ содержит полный набор полей страницы в camelCase (как в карточке)
filter object — Фильтрация по ключевым полям страницы.
Синтаксис фильтрации. Пример: ?filter[siteId]=3. Булево active принимается как true/false, 1/0 или Y/N
scope string — Внутренняя область лендингов. Допустимые значения: KNOWLEDGE (страницы базы знаний), GROUP (страницы рабочих групп), MAINPAGE (главные страницы). Без параметра возвращаются страницы обычных сайтов-лендингов. Принимается как ?scope=KNOWLEDGE или ?filter[scope]=KNOWLEDGE — обе формы дают одинаковый запрос к Битрикс24

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/pages?filter[siteId]=3&limit=10&select=id,title,code,siteId,active,dateCreate,dateModify" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/pages?filter[siteId]=3&limit=10&select=id,title,code,siteId,active,dateCreate,dateModify" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const params = new URLSearchParams({
  'filter[siteId]': '3',
  limit: '10',
  select: 'id,title,code,siteId,active,dateCreate,dateModify',
})

const res = await fetch(`https://vibecode.bitrix24.tech/v1/pages?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} страниц`)

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

javascript 
const params = new URLSearchParams({
  'filter[siteId]': '3',
  limit: '10',
  select: 'id,title,code,siteId,active,dateCreate,dateModify',
})

const res = await fetch(`https://vibecode.bitrix24.tech/v1/pages?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив страниц
data[].id number Идентификатор страницы
data[].title string Название страницы
data[].code string Символьный код страницы
data[].siteId number Идентификатор сайта
data[].active boolean Активна ли страница
data[].description string | null Произвольное описание
data[].createdById number Идентификатор создавшего сотрудника
data[].dateCreate datetime Дата создания. Строка в формате локали портала, не ISO 8601
data[].dateModify datetime Дата последнего изменения. Тот же формат
meta.total number Общее количество записей, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

Формат дат. dateCreate и dateModify — строки в формате локали портала, не ISO 8601 (30.12.2021 12:30:52 на RU-локали, 12/30/2021 12:30:52 pm на EN-локали). Формат одинаков в списке и в карточке; new Date() на таком значении полагаться нельзя. Подробнее: Справочник полей.

URL любой страницы из массива data строится из её id и siteId:

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

<siteId> — ID сайта, которому принадлежит страница (поле siteId каждого элемента). <portal> — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 9,
      "title": "Тест переноса страниц",
      "code": "change1",
      "siteId": 3,
      "active": true,
      "description": null,
      "createdById": 1,
      "dateCreate": "26.05.2020 17:24:02",
      "dateModify": "10.10.2022 15:25:30"
    },
    {
      "id": 7,
      "title": "Test page",
      "code": "test",
      "siteId": 3,
      "active": true,
      "description": null,
      "createdById": 1,
      "dateCreate": "25.05.2020 17:34:17",
      "dateModify": "10.10.2022 15:25:30"
    }
  ],
  "meta": {
    "total": 13,
    "hasMore": true
  }
}

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

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

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

Ошибки

HTTP Код Описание
422 BITRIX_ERROR Битрикс24 вернул ошибку — текст в error.message
403 SCOPE_DENIED API-ключ не имеет скоупа landing
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Постраничный переход через offset поддерживается. Вайбкод возвращает запрошенное окно [offset, offset + limit). Значение meta.total — точное число записей под фильтром, а meta.hasMore показывает, есть ли записи за пределами окна.

Сортировка. Поддерживается через ?order[поле]=asc|desc или короткую форму ?sort=-поле (по убыванию). Без параметра выборка идёт по возрастанию id.

База знаний и другие внутренние области. Параметр scope переключает источник: KNOWLEDGE — страницы базы знаний, GROUP — страницы рабочих групп, MAINPAGE — главные страницы. Без параметра возвращаются страницы обычных сайтов-лендингов (источник по умолчанию). Пример: GET /v1/pages?scope=KNOWLEDGE возвращает страницы базы знаний.

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