Получить страницу
GET /v1/pages/:id
Возвращает одну страницу по идентификатору. Удалённые страницы этим эндпоинтом не возвращаются — на запрос вернётся 404 ENTITY_NOT_FOUND.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
id (path) |
number | да | Идентификатор страницы |
scope (query) |
string | нет | Внутренняя область лендингов: KNOWLEDGE / GROUP / MAINPAGE. Указывайте, если страница принадлежит соответствующей области. Иначе возвращается 404 ENTITY_NOT_FOUND. Пример: GET /v1/pages/9?scope=KNOWLEDGE |
select (query) |
string | нет | Выборка полей: ?select=id,title. Поле id возвращается всегда |
Примеры
curl — личный ключ
curl "https://vibecode.bitrix24.tech/v1/pages/9" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/pages/9" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/pages/9', {
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
})
const { success, data } = await res.json()
console.log('Страница:', data.title, '— сайт:', data.siteId)
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/pages/9', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { success, data } = await res.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
id |
number | Идентификатор страницы |
title |
string | Название страницы |
code |
string | Символьный код страницы |
siteId |
number | Идентификатор сайта |
active |
boolean | Активна ли страница |
description |
string | null | Произвольное описание |
createdById |
number | Идентификатор создавшего сотрудника |
dateCreate |
datetime | Дата создания. Формат Битрикс24 ДД.ММ.ГГГГ ЧЧ:ММ:СС (не ISO 8601) |
dateModify |
datetime | Дата последнего изменения. Формат Битрикс24 ДД.ММ.ГГГГ ЧЧ:ММ:СС (не ISO 8601) |
Формат дат — локаль-зависимый, НЕ ISO 8601. Битрикс24 возвращает
dateCreate/dateModifyстрокой в локальном формате, и конкретный шаблон зависит от региональных настроек портала: на RU-локали этоДД.ММ.ГГГГ ЧЧ:ММ:СС(30.12.2021 12:30:52), на EN-локали —MM/DD/YYYY hh:mm:ss am/pm(04/22/2020 02:39:17 pm). Вайбкод отдаёт значение Битрикс24 как есть, без приведения к ISO.new Date(value)вернётInvalid Dateлибо тихо перепутает день и месяц — не разбирайте дату по фиксированному шаблону и не доверяйтеnew Date(). Ориентируйтесь на региональные настройки конкретного портала.
Пример ответа
{
"success": true,
"data": {
"id": 9,
"title": "Тест переноса страниц",
"code": "change1",
"siteId": 3,
"active": true,
"description": null,
"createdById": 1,
"dateCreate": "30.12.2021 12:30:52",
"dateModify": "30.12.2021 12:30:53"
}
}
Пример ответа при ошибке
404 — страница не найдена:
{
"success": false,
"error": {
"code": "ENTITY_NOT_FOUND",
"message": "landingPage 999999999 not found"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| 404 | ENTITY_NOT_FOUND |
Страница с таким ID не найдена, удалена или недоступна пользователю |
| 403 | SCOPE_DENIED |
API-ключ не имеет скоупа landing |
| 401 | TOKEN_MISSING |
API-ключ не имеет настроенных токенов |
Полный список общих ошибок API — Ошибки.
Смотрите также
- Список страниц — получить несколько страниц с фильтрами
- Обновить страницу — изменение полей
- Удалить страницу — удаление по ID
- Лимиты и оптимизация — rate limits