Skip to main content
GET
/
events
List all events
curl --request GET \
  --url https://api.flatpeak.com/events \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "url": "/events",
  "has_more": true,
  "data": [
    {
      "id": "evt_65e42b7827c0526548432b9f",
      "object": "event",
      "time_created": "2022-01-24T14:15:22Z",
      "type": "device.create",
      "data": {
        "id": "dev_63a6087272941ef077a8fd3e",
        "object": "device",
        "live_mode": true,
        "reference_id": "DEV1234567890",
        "locations": [
          "loc_641b90b758fb8e6293716e40"
        ],
        "manufacturer": "Nova Systems",
        "model_code": "PICOXN2",
        "model_name": "Pico Ultimate",
        "time_created": "2022-01-24T14:15:22Z",
        "account_id": "acc_661677911f2197045e6cf1b1",
        "properties": {
          "power_rating_import_kwh": 14.2,
          "capacity_kwh": 123,
          "power_rating_export_kwh": 7,
          "pv_azimuth": 0,
          "pv_tilt": 23,
          "pv_terrain_shading": false,
          "pv_forecasts_enabled": false,
          "install_date": "2022-03-22T11:12:21Z"
        },
        "last_seen": "2022-03-22T11:12:21Z",
        "flex_enabled": true
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.flatpeak.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authenticate with bearer you obtained from authentication endpoint.

Query Parameters

​
event_type
string

Type of event.

​
starting_after
string

Specifies a cursor for pagination use; defines the place in the list. To retrieve the next page in the list include starting_after where ID is the last ID in the currently retrieved list.

​
ending_before
string

Specifies a cursor for pagination use; defines the place in the list. To retrieve the previous page in the list, include ending_before, which is the first ID in the currently retrieved list.

​
limit
integer

A limit on the number of objects to be returned. Can range between 1 and 100, and the default is 30.

​
object_id
string

Filter events by Flatpeak identifier such as a location ID.

Example:

"loc_641b90b758fb8e6293716e40"

Response

​
object
string

Represents the object’s type. i.e. list.

Example:

"list"

​
url
string

Represents the URL slug for the object.

Example:

"/events"

​
has_more
boolean

Is set to true if more objects are available.

​
data
object[]