Skip to main content
GET
/
schedules
List schedules
curl --request GET \
  --url https://api.example.com/schedules \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "sched_abc123",
      "deviceId": "device_abc123",
      "deviceType": "battery",
      "status": "active",
      "recurrence": {
        "type": "daily"
      },
      "slots": [
        {
          "time": "06:00",
          "action": {
            "action": "set_operation_mode",
            "mode": "charge"
          }
        }
      ],
      "exclusions": {
        "days": [
          "06",
          "07"
        ],
        "dates": [
          {
            "start": "2025-04-01",
            "end": "2025-04-03"
          }
        ]
      },
      "startAt": "2025-03-20T00:00:00Z",
      "finishAt": "2025-06-20T00:00:00Z",
      "createdAt": "2025-03-17T10:30:00Z",
      "updatedAt": "2025-03-17T10:30:00Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "hasMore": true
  }
}
Coming Soon

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
deviceId
string

Filter schedules by device ID

Example:

"device_abc123"

​
status
enum<string>

Filter schedules by status

Available options:
active,
paused,
completed,
cancelled
Example:

"active"

​
offset
number

Number of schedules to skip (default: 0)

Example:

0

​
limit
number

Maximum number of schedules to return (1-50, default: 10)

Example:

10

Response

Schedules retrieved successfully

​
items
object[]
required
​
pagination
object
required