API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Rotation settings

List scheduled rotation jobs of one or more slots

Use this to see which automatic rotations are planned and when they run next. Lists both system jobs (created with rotation_add_job) and selling-port interval jobs. POST is used only to carry the body; nothing changes. Returns an empty list while the scheduler is not running. A missing field returns status false without data.

  • Read only
  • Basic auth
  • Public API · since v20.8.0
  • Hub: routine call
  • getRotationScheduleJobs
POST/v2/schedule/rotation_jobs

Request body application/json · required

positionsinteger[]required

Slots to list; an empty list lists every slot.

pageintegerrequired
limitintegerrequired

Responses

Jobs page, or status false on a bad body.

statusbooleanoptional
dataobjectoptional
data.dataobject[]optional
data.data[].idintegeroptional
data.data[].positionintegeroptional
data.data[].intervalintegeroptional
data.data[].unitstringoptional
One of seconds, minutes, hours
data.data[].specific_timestring | integer | nulloptional

Time of day (hh:mm) the job is aligned to.

data.data[].start_timestring | nulloptional

Start of the daily window (hh:mm:ss); null runs all day.

data.data[].end_timestring | nulloptional
data.data[].enabledinteger | booleanoptional
data.data[].stamp_createdstring | integeroptional
data.data[].typestringoptional

system jobs come from this API; selling jobs come from a selling port interval rotation.

One of system, selling
data.data[].next_runnumber | nulloptional

Epoch seconds of the next run.

data.totalintegeroptional
Verified against XProxy v21.3.2 on Nov 17, 2026