Get a schedule - Amps AI Documentation

GET

schedules

{scheduleId}

curl

curl --request GET \
  --url 'https://api.amps.ai/schedules/sched_abc123' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Schedule not found or access denied."
  },
  "meta": {
    "requestId": "req_5pH1cQbY",
    "timestamp": "2026-04-29T12:00:00.000Z",
    "path": "/schedules/sched_unknown_999",
    "latencyMs": 5
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

scheduleId

string

required

Schedule identifier, as returned in the GET /schedules list and in the device schedule response.

Example:

"sched_abc123"

Response

Schedule not found.

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.

Show child attributes

meta

object

required

Request metadata.

Show child attributes

Schedule a Charge for LaterSchedule a battery charge for later: defer it with a bare start, or bound a cheap-rate window with start and end. Capability check, curl, action lifecycle, cancellation.

curl

curl --request GET \
  --url 'https://api.amps.ai/schedules/sched_abc123' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Schedule not found or access denied."
  },
  "meta": {
    "requestId": "req_5pH1cQbY",
    "timestamp": "2026-04-29T12:00:00.000Z",
    "path": "/schedules/sched_unknown_999",
    "latencyMs": 5
  }
}