For AI agents: markdown of this page — /docs-content-en/infra/wake-schedules/list.md documentation index — /llms.txt

List wake windows

GET /v1/infra/servers/:id/wake-schedules

Returns all wake windows of a server, including disabled ones. Unlike creating and updating, this works regardless of whether scheduled wake is enabled for the Bitrix24 account — so the server owner can see already-declared windows even when the feature is currently unavailable to their account.

Parameters

Parameter In Type Required Description
Parameterid Inpath Typestring (UUID) Requiredyes DescriptionID of the BLACKHOLE server

There are no query parameters — filtering and pagination are not offered for a single server's window list; the 50-windows-per-server cap makes them unnecessary.

Examples

curl — personal key

Terminal 
curl -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.com/v1/infra/servers/SERVER_ID/wake-schedules

curl — OAuth application

Terminal 
curl -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.com/v1/infra/servers/SERVER_ID/wake-schedules

JavaScript — personal key

javascript 
const res = await fetch(
  `https://vibecode.bitrix24.com/v1/infra/servers/${serverId}/wake-schedules`,
  { headers: { 'X-Api-Key': 'YOUR_API_KEY' } }
)
const { data } = await res.json()
console.log(`Windows: ${data.length}, enabled: ${data.filter(w => w.enabled).length}`)

JavaScript — OAuth application

javascript 
const res = await fetch(
  `https://vibecode.bitrix24.com/v1/infra/servers/${serverId}/wake-schedules`,
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionThe server's windows, including disabled ones
Fielddata[].id Typestring DescriptionWindow ID
Fielddata[].serverId Typestring (UUID) DescriptionID of the owning server
Fielddata[].cronExpr Typestring DescriptionThe window's cron expression
Fielddata[].timezone Typestring DescriptionThe window's IANA timezone
Fielddata[].label Typestring | null DescriptionWindow label
Fielddata[].lead Typenumber | null DescriptionMargin in seconds before the cronExpr moment. null means the server's or platform's margin is used
Fielddata[].enabled Typeboolean DescriptionWhether the window is active
Fielddata[].source Typestring DescriptionHow the window was created. Always "MANUAL" for windows created through this CRUD
Fielddata[].lastFiredAt Typestring (ISO 8601) | null DescriptionTimestamp of the last confirmed firing
Fielddata[].wakeAttemptStartedAt Typestring (ISO 8601) | null DescriptionInternal scheduler claim marker, normally null
Fielddata[].lastWakeLateAt Typestring (ISO 8601) | null DescriptionTimestamp of the last late wake. null if there have been no late wakes
Fielddata[].createdAt Typestring (ISO 8601) DescriptionRecord creation date
Fielddata[].updatedAt Typestring (ISO 8601) DescriptionDate of the last update to the record

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": "cm38x02qp0001ml08g7k3h2a",
      "serverId": "e765edfc-ba0a-43de-b8ea-838dd872c522",
      "cronExpr": "0 9 * * 1-5",
      "timezone": "America/New_York",
      "label": "daily report",
      "lead": null,
      "enabled": true,
      "source": "MANUAL",
      "lastFiredAt": "2026-07-10T06:00:04.000Z",
      "wakeAttemptStartedAt": null,
      "lastWakeLateAt": null,
      "createdAt": "2026-07-03T08:12:00.000Z",
      "updatedAt": "2026-07-03T08:12:00.000Z"
    },
    {
      "id": "cm38x19rt0002ml08a1z9k7b",
      "serverId": "e765edfc-ba0a-43de-b8ea-838dd872c522",
      "cronExpr": "0 22 * * *",
      "timezone": "America/New_York",
      "label": "nightly cleanup",
      "lead": 300,
      "enabled": false,
      "source": "MANUAL",
      "lastFiredAt": null,
      "wakeAttemptStartedAt": null,
      "lastWakeLateAt": null,
      "createdAt": "2026-07-05T11:40:00.000Z",
      "updatedAt": "2026-07-08T09:02:00.000Z"
    }
  ]
}

Error response example

404 — server not found:

JSON 
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Server not found"
  }
}

Errors

HTTP Code Description
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeINVALID_API_KEY DescriptionThe key is not recognized — no such key exists on the platform
HTTP403 CodeSERVER_ROLE_FORBIDDEN DescriptionYou are on this server's development team with the Developer role, and this operation is open to the Administrator role. error.hint carries your role, the required threshold and the list of calls that are open to you. Role breakdown — List servers
HTTP404 CodeNOT_FOUND DescriptionThe server was not found, was deleted, or belongs to a different API key while you are not on its development team
HTTP429 CodeRATE_LIMITED DescriptionThe platform's overall request rate limit was exceeded

Full list of shared error codes — Errors.

Known specifics

  • Not gated by the feature's per-account status. Unlike creating and updating, listing works even while scheduled wake is not enabled for the Bitrix24 account or for Galaxy apps (WAKE_SCHEDULE_DISABLED and WAKE_SCHEDULE_GALAXY_DISABLED are never returned here) — so the server owner sees already-declared windows regardless of whether the feature is currently available to their account.
  • Item order. The array is sorted by window creation date (createdAt, ascending) — newer windows appear last.

See also