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

Получить адрес системной страницы

GET /v1/sites/:id/system-pages/:type/url

Возвращает публичный адрес страницы, назначенной на системную роль, например чтобы поставить ссылку на корзину или личный кабинет.

Параметры

Параметр	Тип	Обяз.	Описание
`id` (path)	number	да	ID сайта. Список: `GET /v1/sites`
`type` (path)	string	да	Роль: `mainpage`, `catalog`, `personal`, `cart`, `order`, `payment`, `compare`, `feedback`. Что значит каждая — Системные страницы
`scope` (query)	string	нет	Внутренняя область лендингов: `KNOWLEDGE` / `GROUP` / `MAINPAGE`. Указывайте, если сайт принадлежит соответствующей области. Иначе возвращается `404 ENTITY_NOT_FOUND`. Для обычного сайта не передаётся

Других query-параметров метод не принимает: любой другой отвечает 400 INVALID_PARAMS.

Примеры

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

Terminal

curl "https://vibecode.bitrix24.tech/v1/sites/223/system-pages/personal/url" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal

curl "https://vibecode.bitrix24.tech/v1/sites/223/system-pages/personal/url" \
  -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/223/system-pages/personal/url', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

if (success) {
  console.log('Личный кабинет:', data.url)
} else if (error.message === 'System-page binding not found') {
  console.log('Роль не назначена')
} else {
  console.log('Ошибка:', error.code, error.message)
}

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

javascript

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

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

Поля ответа

Поле	Тип	Описание
`success`	boolean	Всегда `true` при успехе
`data.url`	string	Публичный адрес страницы, назначенной на роль

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

JSON

{
  "success": true,
  "data": {
    "url": "https://b24-y4xx51.bitrix24site.ru/docs-personal/"
  }
}

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

404 — на роль не назначена страница: