Skip to content

List chargers with pagination by their namespace

Deprecated
POST
/api/chargers/list

Post /api/chargers/list

Parameters

Header Parameters

x-compatibility-date
required
string
Allowed values: 2024-04-11

Request Body required

object
where
required
object
locationId
Any of:
string
type
Any of:
string
Allowed values: Private Public
status
Any of:
string
Allowed values: Available Preparing Charging SuspendedEVSE SuspendedEV Finishing Reserved Unavailable Faulted
plugncharge
boolean
connectors
object
type
Any of:
string
Allowed values: J1772_Type1 Mennekes_Type2 GBT_AC Tesla CCS1 CCS2 CHAdeMO GBT_DC Other
status
Any of:
string
Allowed values: Available Preparing Charging SuspendedEVSE SuspendedEV Finishing Reserved Unavailable Faulted
maxPower
Any of:
number
>= -9007199254740991 <= 9007199254740991
maxCurrent
Any of:
number
>= -9007199254740991 <= 9007199254740991
pagination
object
skip
integer
>= -9007199254740991 <= 9007199254740991
take
integer
>= -9007199254740991 <= 9007199254740991

Responses

200

Response for status ok

object
success
required
boolean
chargers
required
Array
Any of:
object
id
required
string
applicationId
required
string
namespaceId
required
string
locationId
string
userId
required
string
type
required
string
Allowed values: Private Public
name
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
tier
required
string
Allowed values: free enterprise
plugncharge
boolean
disableCharging
boolean
requireTLS
boolean
basicAuthPassword
string
ipWhitelist
string
asnWhitelist
string
connectionUrl
string
ocppVersion
string
ipAddress
string
userAgent
string
tlsVersion
string
state
required
string
Allowed values: Disconnected PreBooting Booting Ready
disconnectedReason
string
Allowed values: NeverConnected ConnectionLost ConnectionClosed ConnectionError Restarting Reconnecting
status
string
Allowed values: Available Preparing Charging SuspendedEVSE SuspendedEV Finishing Reserved Unavailable Faulted
statusSince
string format: date-time
error
string
Allowed values: ConnectorLockFailure EVCommunicationError GroundFailure HighTemperature InternalError LocalListConflict NoError OtherError OverCurrentFailure OverVoltage PowerMeterFailure PowerSwitchFailure ReaderFailure ResetFailure UnderVoltage WeakSignal
connectedSince
string format: date-time
disconnectedSince
string format: date-time
firmwareUpdateStatus
string
diagnosticsUploadStatus
string
nextKeycardAction
string
Allowed values: BindToNamespace BindToLocation BindToCharger Unbind
tierExpiry
string format: date-time
diagnosticsId
string
diagnosticsIdExpiry
string format: date-time
initialized
required
boolean
vendor
model
connectors
metadata
configuration
profiles
localAuthList
count
required
number

400

Response for status badRequest

object
success
required
boolean
message
required
string

403

Response for status forbidden

object
success
required
boolean
message
required
string

500

Response for status internalServerError

object
success
required
boolean
message
required
string