Flip Energy API
  1. Devices
Flip Energy API
  • Overview
  • Important concepts
  • Authentication
  • Enrollment process
  • End-user app design
  • Monitoring / Telemetry
  • Control
  • Change log
  • Mobile App API
    • Devices
      • Create Device
        POST
      • Read Devices
        GET
      • Read Device
        GET
      • Update Device
        PATCH
      • Delete Device
        DELETE
    • Enrollments
      • Create Enrollment
      • Read Enrollments
      • Read Enrollment
      • Delete Enrollment
    • Events
      • Read Events
      • Read Event
      • Update Event Participation
    • Programs
      • Read Programs
      • Read Program
    • Sites
      • Read Site
      • Update Site
  • Cloud API
    • Sites
      • Get Site Token
      • Get Sites
    • Commissioning
      • Commission Site And Devices
    • Sessions
      • Sessions
    • Commands
      • Command Created
      • Update Command Status
    • Programs
      • Read Programs
    • Telemetry
      • Report Battery Telemetry
    • Webhooks
      • Overview
      • List of events
      • Webhook headers
      • Schemas
        • Command
        • Enrollment
        • Event
  1. Devices

Read Devices

Cloud Mock
https://mock.apidog.com/m1/479670-0-default
Cloud Mock
https://mock.apidog.com/m1/479670-0-default
GET
/v1/site/{siteId}/devices
devices

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
siteId
string 
required
Example:
abc-789
Query Params
skip
integer 
Skip
optional
Default:
0
limit
integer 
Limit
optional
Default:
100

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://mock.apidog.com/m1/479670-0-default/v1/site//devices?skip&limit'

Responses

🟢200Successful Response
application/json
Body
array of:
id
string 
Id
read-onlyrequired
Example:
xyz-123
site_id
string 
required
Example:
abc-789
manufacturer_name
string 
Manufacturer Name
required
Example:
DeviceMaker
product_name
string 
Product Name
required
Example:
Model 1
serial_number
string 
Serial Number
required
Example:
123456789
type
enum<string> 
required
Allowed values:
BATTERYEV_CHARGER
install_date
string <date-time>
required
Example:
2022-02-22
created_at
string <date-time>
Created At
read-onlyrequired
updated_at
string <date-time>
Updated At
read-onlyrequired
Example
[
    {
        "id": "xyz-123",
        "site_id": "abc-789",
        "manufacturer_name": "DeviceMaker",
        "product_name": "Model 1",
        "serial_number": "123456789",
        "type": "BATTERY",
        "install_date": "2022-02-22",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
    }
]
🟠400Invalid input
Previous
Create Device
Next
Read Device
Built with