Skip to main content
GET
/
events
/
{id}
Retrieve an event
curl --request GET \
  --url https://api.flatpeak.com/events/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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.

Path Parameters

​
id
string
required

unique Flatpeak event identifier

Example:

"evt_3e82b87128ad42c0a352a7305219bfa2"

Response

​
id
string

Flatpeak unique event id.

Example:

"evt_65e42b7827c0526548432b9f"

​
object
string

Represents the object’s type, i.e. event.

Example:

"event"

​
time_created
string

Time when the object was created, in UTC.

Example:

"2022-01-24T14:15:22Z"

​
type
string

Flatpeak object type in the payload. For example customer.create.

Example:

"device.create"

​
data
Device · object

This object represents a device or another asset of a compatible type.