Для AI-агентов: markdown этой страницы — /docs-content/infra/work-schedules/list.md индекс документации — /llms.txt
Список расписаний
GET /v1/work-schedules
Возвращает библиотеку расписаний работы портала — готовые расписания платформы и свои — с числом серверов, назначенных на каждое.
Параметры
Параметров нет. Библиотека портала ограничена тремя готовыми расписаниями и 50 своими, поэтому фильтрация и пагинация не предусмотрены.
Примеры
curl — личный ключ
curl -H "X-Api-Key: YOUR_API_KEY" \
https://vibecode.bitrix24.tech/v1/work-schedules
curl — OAuth-приложение
curl -H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
https://vibecode.bitrix24.tech/v1/work-schedules
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/work-schedules', {
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
const own = data.filter(s => s.kind === 'CUSTOM')
console.log(`Расписаний: ${data.length}, своих: ${own.length}`)
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/work-schedules', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { data } = await res.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
success |
boolean | Всегда true при успехе |
data |
array | Расписания портала: сначала готовые, затем свои в порядке создания |
data[].id |
string | ID расписания. Его принимают смена режима сервера и остальные операции библиотеки |
data[].kind |
string | PRESET — готовое расписание платформы, CUSTOM — своё |
data[].name |
string | Название. У готового расписания — на языке владельца ключа |
data[].presetKey |
string | null | Ключ готового расписания: weekdays-9-18, weekdays-8-20, daily-9-21. У своего — null |
data[].timezone |
string | Часовой пояс IANA, в котором читаются окна |
data[].windows |
array | Окна { isoDay, start, end } в местном времени. Правила окон — в индексе раздела |
data[].version |
number | Номер версии. Передаётся в обновление |
data[].canEdit |
boolean | Вправе ли владелец ключа править и удалять расписание. У готового всегда false |
data[].assignedCount |
number | Сколько серверов портала работает по расписанию, включая серверы других сотрудников. Сами серверы не называются |
Пример ответа
{
"success": true,
"data": [
{
"id": "cmfp4qz7x00031ocg5d1a8k2m",
"kind": "PRESET",
"name": "Будни 9–18",
"presetKey": "weekdays-9-18",
"timezone": "Europe/Moscow",
"windows": [
{ "isoDay": 1, "start": "09:00", "end": "18:00" },
{ "isoDay": 2, "start": "09:00", "end": "18:00" },
{ "isoDay": 3, "start": "09:00", "end": "18:00" },
{ "isoDay": 4, "start": "09:00", "end": "18:00" },
{ "isoDay": 5, "start": "09:00", "end": "18:00" }
],
"version": 1,
"canEdit": false,
"assignedCount": 3
},
{
"id": "cmfp4r0q2000a1ocg7h2k9x3d",
"kind": "CUSTOM",
"name": "Смены склада",
"presetKey": null,
"timezone": "Europe/Moscow",
"windows": [
{ "isoDay": 1, "start": "09:00", "end": "18:00" },
{ "isoDay": 2, "start": "09:00", "end": "13:00" },
{ "isoDay": 2, "start": "14:00", "end": "24:00" }
],
"version": 2,
"canEdit": true,
"assignedCount": 1
}
]
}
Пример ответа при ошибке
403 — у ключа нет скоупа vibe:infra:
{
"success": false,
"error": {
"code": "INFRA_SCOPE_REQUIRED",
"message": "This API key does not have infrastructure rights (scope vibe:infra).",
"details": { "requiredScope": "vibe:infra" }
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| 401 | MISSING_API_KEY |
Не передан заголовок X-Api-Key |
| 401 | INVALID_API_KEY |
Ключ не опознан: такой строки на платформе нет |
| 403 | INFRA_SCOPE_REQUIRED |
У ключа нет скоупа vibe:infra |
| 403 | INFRA_FORBIDDEN_FOR_COWORK_KEY |
Вызов сделан ключом Cowork/Code. Библиотека расписаний управляет серверами и их счётом, поэтому такому ключу она закрыта целиком, включая чтение. Что делать — Проектный ключ для деплоя |
| 404 | NOT_FOUND |
Ключ не привязан к порталу Битрикс24 |
| 429 | RATE_LIMITED |
Превышен лимит 60 запросов в минуту на ключ. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики) |
Полный список общих ошибок API — Ошибки.
Известные особенности
- До включения режимов список пуст. Готовые расписания заводятся в библиотеке портала вместе с включением режимов работы, свои до этого создать нельзя. Пустой
dataу такого портала — не ошибка. nameу готового расписания зависит от ключа. Название не хранится в данных, а переводится на язык владельца ключа, поэтому два ключа одного портала могут получить разные строки. Опознавать готовое расписание надёжно поpresetKey.