Получить сайт

GET /v1/sites/:id

Возвращает один сайт по идентификатору.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор сайта
scope (query) string нет Внутренняя область лендингов: KNOWLEDGE / GROUP / MAINPAGE. Указывайте, если сайт принадлежит соответствующей области. Иначе возвращается 404 ENTITY_NOT_FOUND. Пример: GET /v1/sites/42?scope=KNOWLEDGE

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/sites/157" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/sites/157" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/sites/157', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Сайт:', data.title, '—', data.type)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/sites/157', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Возвращается полный объект сайта со всеми полями — см. Поля.

Формат дат — локаль-зависимый, не ISO 8601. 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). Значение возвращается как есть — new Date(value) даст Invalid Date либо перепутает день и месяц.

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

JSON 
{
  "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"
  }
}

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

404 — сайт не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "site 999999999 not found"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Сайт с таким ID не найден или недоступен пользователю
403 SCOPE_DENIED API-ключ не имеет скоупа landing
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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