Get chargers

x-ms-visibility: "important"

Retrieve a list of all chargers associated with the user.

Query Parameters

page int32

Page to be fetched. Default: 1

limit int32

Limit (No. of records per page). Max value: 100. Default: 100.

sortKey string

Sort field to be used. Default: 'ChargerId'

sortDescending boolean

Set to 'true' to sort descending based on sort key. Default: 'false'

siteId int32

Filter chargers by site ID.

externalSiteId string

Filter chargers by external site ID.

search string

Free text filter for charger name.

Responses

• 200
• 400
• 401

---

List of chargers accessible by the user.

application/json

Schema

Example (from schema)

---

Schema

page int32
limit int32
totalRecords int32
hasNextPage boolean
hasPreviousPage boolean
items object[]
Array [
id int64
chargerId string
name string
state int32
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
Default value: 0
siteId int64
siteName string
model string
manufacturer string
firmware string
serial string
activeConnection boolean nullable
iccid string
imsi string
meterType string
meterSerialNumber string
pushIntegrationEnabled boolean nullable
chargerSpecificMessageStructure boolean nullable
evseId string
splitEvseBySocket boolean nullable
physicalReference string
socketDict object
property name* socketInfo
type string
maxPower string
status string
id int32
name string
deviceEvseId int32 nullable
deviceConnectorId int32 nullable
format string
socketPowerType string
maxWatts int32 nullable
maxVoltage int32 nullable
maxAmperage int32 nullable
phaseRotation string
termsAndConditions uri
lastUpdated date-time
chargingStationEvseId int32 nullable
sockets object[]
Array [
type string
maxPower string
status string
id int32
name string
deviceEvseId int32 nullable
deviceConnectorId int32 nullable
format string
socketPowerType string
maxWatts int32 nullable
maxVoltage int32 nullable
maxAmperage int32 nullable
phaseRotation string
termsAndConditions uri
lastUpdated date-time
chargingStationEvseId int32 nullable
]
location object
latitude double
longitude double
streetAddress string
streetNumber string
houseLetter string
postalNumber string
city string
area string
country string
capabilities int32[]
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
chargerConfigurations object[]
Array [
configName string
configValue string
canBeChanged boolean
]
ongoingTransactions object[]
Array [
socketId int32
transactionId int32
evseTransactionId string
]
customProperties object
property name* string
integrationRelays string[]
metadata string[]
]

{
  "page": 0,
  "limit": 0,
  "totalRecords": 0,
  "hasNextPage": true,
  "hasPreviousPage": true,
  "items": [
    {
      "id": 0,
      "chargerId": "string",
      "name": "string",
      "state": 0,
      "siteId": 0,
      "siteName": "string",
      "model": "string",
      "manufacturer": "string",
      "firmware": "string",
      "serial": "string",
      "activeConnection": true,
      "iccid": "string",
      "imsi": "string",
      "meterType": "string",
      "meterSerialNumber": "string",
      "pushIntegrationEnabled": true,
      "chargerSpecificMessageStructure": true,
      "evseId": "string",
      "splitEvseBySocket": true,
      "physicalReference": "string",
      "socketDict": {},
      "sockets": [
        {
          "type": "string",
          "maxPower": "string",
          "status": "string",
          "id": 0,
          "name": "string",
          "deviceEvseId": 0,
          "deviceConnectorId": 0,
          "format": "string",
          "socketPowerType": "string",
          "maxWatts": 0,
          "maxVoltage": 0,
          "maxAmperage": 0,
          "phaseRotation": "string",
          "termsAndConditions": "string",
          "lastUpdated": "2025-02-17T11:24:21.318Z",
          "chargingStationEvseId": 0
        }
      ],
      "location": {
        "latitude": 0,
        "longitude": 0,
        "streetAddress": "string",
        "streetNumber": "string",
        "houseLetter": "string",
        "postalNumber": "string",
        "city": "string",
        "area": "string",
        "country": "string"
      },
      "capabilities": [
        0
      ],
      "chargerConfigurations": [
        {
          "configName": "string",
          "configValue": "string",
          "canBeChanged": true
        }
      ],
      "ongoingTransactions": [
        {
          "socketId": 0,
          "transactionId": 0,
          "evseTransactionId": "string"
        }
      ],
      "customProperties": {},
      "integrationRelays": [
        "string"
      ],
      "metadata": [
        "string"
      ]
    }
  ]
}

Exception Details

application/json

Schema

Example (from schema)

---

Schema

errorCode string
message string
errorNumber int32
helpLink string

{
  "errorCode": "string",
  "message": "string",
  "errorNumber": 0,
  "helpLink": "string"
}

User not authorised

Loading...