Skip to main content
GET
/
schedules
curl
curl --request GET \
  --url 'https://api.amps.ai/schedules' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'
{
  "success": false,
  "error": {
    "code": "NOT_IMPLEMENTED",
    "message": "Schedule listing is not yet implemented."
  },
  "meta": {
    "requestId": "req_NotImplYet2",
    "timestamp": "2026-04-29T12:00:00.000Z",
    "path": "/schedules",
    "latencyMs": 1
  }
}

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.