Skip to main content
GET
curl
Coming soon. First-class schedules are on the roadmap. Until they ship, this route answers 501 Not Implemented.Schedule the work one command at a time instead. Send a push with start to run a command later, or with start and end to run it for a window. Send one push for each time you want something to happen.A device that lists auto.schedule in its commands map already runs its own stored program when you send that command.

Authorizations

x-api-key
string
header
required

Query Parameters

offset
number

Pagination offset (default 0).

Example:

0

limit
number

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

Example:

10

userId
string

Filter by the end-user (userId) the device is linked to.

Example:

"user_abc123"

state
enum<string>

Filter by schedule state.

Available options:
pending,
active,
completed,
cancelled
deviceId
string

Filter to a single device. A deviceId the customer does not own returns an empty page.

Example:

"device_abc123"

Response

501 - application/json

Scheduler not yet implemented.

Uniform error response. The error.code identifies the failure, error.message carries a human-readable explanation, and error.details carries structured context (failed fields, conflicting action IDs, supported capabilities) where relevant.

success
boolean
required

Always false for error responses.

error
object
required

Error envelope.

meta
object
required

Request metadata.