v1

latestOpenAPI 3.0.42026-07-241876123.9 KB
Charger

Charger details

Retrieves the specified charger (requires owner or service permissions).

get/api/chargers/{id}

Path parameters

idstring uuid required

Charger ID

Query parameters

includeServiceLevelTechnicalReadAccessboolean

Include Zaptec.ZapCloud.WebAPI.Models.ChargerListModel.CurrentUserHasServiceLevelTechnicalReadAccess: whether the current user is entitled to TechnicalRead (debug-log) access on this charger, granted through a user group that carries the TechnicalRead service-level entitlement and has an effective Owner permission on the charger (including inherited and wildcard targets).

Response

OK

idstring uuid

Get the unique identifier of the charge point.

midstring nullable

<strong>This property is obsolete and is scheduled for removal,</strong> please use DeviceId instead.

deviceIdstring nullable

Get the deviceId (serialNo) of the charging stations used with the charge point.

serialNostring nullable

<strong>This property is obsolete and is scheduled for removal,</strong> please use Name instead.

namestring nullable

Get the name of the charge point.

createdOnDatestring date-time nullable

Get the date and time the installation was created.

circuitIdstring uuid nullable

Get the unique identifier the charge point is installed in.

activeboolean nullable

Get a value indicating whether the charge point is active.

currentUserRoles0 | 1 | 2 | 4 | 8 | 15 | 16 | 32 | 64 | 128 | 256

0 = None

1 = User

2 = Owner

4 = Maintainer

8 = Administrator

15 = Any

16 = Onboarding

32 = DeviceAdministrator

64 = PartnerAdministrator

128 = Technical

256 = InternalData

pinstring nullable

Get the charger PIN code. This will only be provided if your user is system owner for the charge point.

templateIdstring uuid nullable

Get the unique identifier of the chargers firmware template.

propertyOcppUrlstring nullable
propertyOcppPasswordstring nullable
propertyPinOfflinePhaseboolean nullable
propertyAuthenticationDisabledboolean nullable
hasSessionsboolean nullable
propertyOfflinePhaseOverride0 | 1 | 2 | 4 | 7

0 = None

1 = Phase_1

2 = Phase_2

4 = Phase_3

7 = All

propertyOfflineCurrentOverridenumber double nullable
propertyOcppVerboseLogUntilstring date-time nullable
propertyOcppDefaultIdTagstring nullable
propertyOcppWebSocketPingIntervalinteger nullable
propertyPrioritizedCurrentnumber double nullable
propertyPrioritizedPhases1 | 3

1 = One

3 = Three

propertyMaxSinglePhaseChargeCurrentnumber double nullable
propertyOcppAvailabilityinteger nullable
propertyOcppOfflineListVersioninteger nullable
signedMeterValueKwhnumber double nullable
signedMeterValuestring nullable
signedSessionEichrechtstring nullable
deviceType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

0 = Unknown

1 = Smart

2 = Portable

3 = HomeApm

4 = Apollo

5 = OtherApm

6 = GenericApm

7 = HanApm

8 = TicApm

installationNamestring nullable
installationIdstring uuid nullable
authenticationType0 | 1 | 2 | 3

0 = Native

1 = WebHooks

2 = Ocpp

3 = OcppNative

isAuthorizationRequiredboolean nullable
currentUserHasServiceLevelTechnicalReadAccessboolean nullable

Service-level entitlement flag (not a regular role/permission): true when the current user is entitled to TechnicalRead (debug-log) access on this charger. The entitlement is granted through a user group that carries the Zaptec.ZapCloud.Domain.Models.ServiceLevel.TechnicalRead service level and has an effective Owner permission on the charger (including inherited and wildcard targets). Used by the frontend to decide whether to surface relevant UI. null unless explicitly requested (opt-in).

operatingMode0 | 1 | 2 | 3 | 5

0 = Unknown

1 = Disconnected

2 = Connected_Requesting

3 = Connected_Charging

5 = Connected_Finished

isOnlineboolean
warningsstring nullable