Skip to main content
GET
/
actions
curl
curl --request GET \
  --url 'https://api.amps.ai/actions' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'
{
  "success": true,
  "data": {
    "items": [
      {
        "id": "act_20260507110hvac02",
        "deviceId": "device_hvac_001",
        "deviceType": "hvac",
        "command": "follow_schedule",
        "parameters": null,
        "state": "completed",
        "result": {
          "success": true
        },
        "errorCode": null,
        "errorMessage": null,
        "createdAt": "2026-05-07T11:00:00.000Z",
        "updatedAt": "2026-05-07T11:00:01.000Z",
        "acknowledgedAt": "2026-05-07T11:00:00.500Z",
        "completedAt": "2026-05-07T11:00:01.000Z",
        "start": null,
        "end": null,
        "links": {
          "self": "/actions/act_20260507110hvac02"
        }
      },
      {
        "id": "act_2026050709a1b2c3",
        "deviceId": "device_abc123",
        "deviceType": "battery",
        "command": "charge",
        "parameters": {
          "target": {
            "value": 100,
            "unit": "percent"
          }
        },
        "state": "scheduled",
        "result": null,
        "errorCode": null,
        "errorMessage": null,
        "createdAt": "2026-05-07T08:00:00.000Z",
        "updatedAt": "2026-05-07T08:00:00.000Z",
        "acknowledgedAt": null,
        "completedAt": null,
        "start": "2026-06-01T02:00:00.000Z",
        "end": null,
        "links": {
          "self": "/actions/act_2026050709a1b2c3"
        }
      },
      {
        "id": "act_2026050615e6f7d8",
        "deviceId": "device_abc123",
        "deviceType": "battery",
        "command": "auto.balanced",
        "parameters": null,
        "state": "completed",
        "result": {
          "success": true,
          "message": "Mode applied"
        },
        "errorCode": null,
        "errorMessage": null,
        "createdAt": "2026-05-06T15:30:00.000Z",
        "updatedAt": "2026-05-06T15:30:04.000Z",
        "acknowledgedAt": "2026-05-06T15:30:01.000Z",
        "completedAt": "2026-05-06T15:30:04.000Z",
        "start": null,
        "end": null,
        "links": {
          "self": "/actions/act_2026050615e6f7d8"
        }
      }
    ],
    "pagination": {
      "limit": 10,
      "offset": 0,
      "total": 3,
      "hasMore": false
    }
  },
  "meta": {
    "requestId": "req_8a2Bf3kP",
    "environment": "sandbox",
    "timestamp": "2026-06-02T12:00:00.000Z",
    "latencyMs": 12
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
offset
number

Number of actions to skip (default: 0).

Example:

0

​
limit
number

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

Example:

10

​
userId
string

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

Example:

"user_abc123"

​
type
enum<string>

Filter by device type.

Available options:
battery,
hvac,
ev_charger,
solar_inverter,
vehicle
​
state
enum<string>

Filter by action lifecycle state.

Available options:
acknowledged,
completed,
failed,
scheduled,
cancelled
​
deviceId
string

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

Example:

"device_abc123"

Response

Actions retrieved successfully.

​
success
boolean
required

Always true for success responses.

​
data
Paginated Action Response · object
required

Paginated list of actions for a device, ordered most recent first.

​
meta
Response Meta · object
required

Metadata attached to every response: the request identifier, the serving environment, the build timestamp, and the server-side latency.