Поля страницы

GET /v1/pages/fields

Возвращает карту всех полей страницы с типом и признаком только для чтения. Поля без этого признака доступны для записи при создании и обновлении.

Примеры

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

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

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

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

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

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

const { success, data } = await res.json()
console.log('Полей:', Object.keys(data.fields).length)

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

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

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

Поля ответа

Объект data содержит карту fields (имя поля → { type, readonly }), список batch с операциями массового режима, список доступных include и набор aggregatable полей для группировки в агрегации.

Поле Битрикс24 Тип RO Описание
id ID number да Идентификатор страницы
title TITLE string Название, до 255 символов
code CODE string Символьный код в URL. Без /, авто-генерация из title
siteId SITE_ID number Сайт-владелец. Источник: GET /v1/sites
active ACTIVE boolean Активна ли страница. Принимается при записи, но не сохраняется — управляется в интерфейсе портала
description DESCRIPTION string | null Описание. null, если не задано
xmlId XML_ID string | null Внешний код
deleted DELETED string да Признак корзины: "Y" / "N"
public PUBLIC string Публичность: "Y" / "N"
sys SYS string да Системная страница Битрикс24: "Y" / "N"
views VIEWS number да Счётчик просмотров
tplId TPL_ID number Идентификатор шаблона
tplCode TPL_CODE string | null да Символьный код шаблона
sitemap SITEMAP string Включать в карту сайта: "Y" / "N"
folder FOLDER string Является ли страница папкой-разделом: "Y" / "N"
folderId FOLDER_ID number Идентификатор папки-раздела сайта
searchContent SEARCH_CONTENT string да Индексируемое содержимое страницы для поиска по сайту
version VERSION number да Версия внутренней структуры страницы
historyStep HISTORY_STEP number да Служебное поле истории изменений
modifiedById MODIFIED_BY_ID number да Последний редактор. Поиск: GET /v1/users
domainId DOMAIN_ID number да Идентификатор домена сайта
initiatorAppCode INITIATOR_APP_CODE string да Код приложения, создавшего страницу
rule RULE string да Служебное поле Битрикс24
createdById CREATED_BY_ID number да Создатель. Поиск: GET /v1/users
dateCreate DATE_CREATE datetime да Дата создания. Формат локали Битрикс24, не ISO 8601
dateModify DATE_MODIFY datetime да Дата последнего изменения. Формат локали Битрикс24
datePublic DATE_PUBLIC datetime да Дата публикации. У неопубликованной страницы приходит пустым объектом {}

Доступные include

Эндпоинт возвращает список доступных include: site — сайт-владелец страницы. Подробнее: Связанные данные.

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "title": { "type": "string", "readonly": false },
      "siteId": { "type": "number", "readonly": false },
      "active": { "type": "boolean", "readonly": false }
    },
    "relations": {
      "site": { "type": "one", "entity": "site", "includable": true }
    },
    "aggregatable": ["siteId", "active", "deleted", "public", "folderId", "tplId", "createdById", "modifiedById"],
    "batch": ["create", "update", "delete"],
    "include": ["site"]
  }
}

Показаны 4 из 27 полей. Полный список — в таблице выше.

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

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

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

Ошибки

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

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

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