List actions

GET

actions

curl

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

const response = await fetch('https://api.amps.ai/actions', {
  method: 'GET',
  headers: {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
  },
});

const data = await response.json();

import requests

url = 'https://api.amps.ai/actions'
headers = {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
}

response = requests.get(url, headers=headers)
data = response.json()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.amps.ai/actions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.amps.ai/actions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.amps.ai/actions")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.amps.ai/actions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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.

Show child attributes

meta

Response Meta · object

required

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

Show child attributes

Get action statusRetrieve the current state of any device action for polling. The action lifecycle progresses `scheduled` (deferred only) -> `acknowledged` -> `completed` | `failed`, with `cancelled` reachable from `scheduled`. The `deviceType` field discriminates the device family and the `command`/`parameters` shape.

curl

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

const response = await fetch('https://api.amps.ai/actions', {
  method: 'GET',
  headers: {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
  },
});

const data = await response.json();

import requests

url = 'https://api.amps.ai/actions'
headers = {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
}

response = requests.get(url, headers=headers)
data = response.json()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.amps.ai/actions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.amps.ai/actions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.amps.ai/actions")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.amps.ai/actions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
  }
}

Get Started

Concepts

API Reference

Guides

Quick reference

More

Authorizations

Query Parameters

Response