/chargers

List Chargers

• field[] (query) — An optional array of Charger fields that should be included in the response, for example: `?field[]=information&field[]=chargeState` By default, no optional fields are included and only the Charger ID will be returned. Response time will generally be slower the more fields you request.

/chargers/{chargerId}

Get Charger

• chargerId (path, required) — ID of the Charger

/chargers/{chargerId}/charging

Control Charging

• chargerId (path, required) — ID of the Charger

/charging-locations

List Charging Locations

/charging-locations

Create Charging Location

/charging-locations/{chargingLocationId}

Delete Charging Location

• chargingLocationId (path, required) — ID of the Charging Location

/charging-locations/{chargingLocationId}

Get Charging Location

• chargingLocationId (path, required) — ID of the Charging Location

/charging-locations/{chargingLocationId}

Update Charging Location

• chargingLocationId (path, required) — ID of the Charging Location

/health/ready

Check Service Readiness

/health/vendors

Check Available Vendors

/me

Get My User

/me/vendors/{vendor}

Disconnect Vendor

• vendor (path, required) — Vendor to be unlinked

/statistics/charging

Get User Charging Statistics

• resolution (query) — The unit of time the data will be cut into before aggregate statistics are applied. For instance if you choose DAY, then each item in the returned array will cover 1 day.
• startDate (query, required) — Earliest date to include in the response
• endDate (query) — Latest date to include in the response (defaults to current date/time)
• vehicleId (query) — Filter statistics to only include this vehicle
• chargingLocationId (query) — Filter statistics to only include this charging location

/users/{userId}

Unlink User

• userId (path, required) — ID of the User

/users/{userId}/authorization

Deauthorize User

• userId (path, required) — ID of the User

/users/{userId}/link

Link User

• userId (path, required) — ID of the User

/vehicles

List Vehicles

• field[] (query) — An optional array of Vehicle fields that should be included in the response, for example: `?field[]=information&field[]=location` By default, no fields are included and only the Vehicle ID will be returned. Response time may be impacted by which fields you request.

/vehicles/{vehicleId}

Get Vehicle

• vehicleId (path, required) — ID of the Vehicle
• field[] (query) — An optional array of Vehicle fields that should be included in the response, for example: `?field[]=information&field[]=location` By default, no fields are included and only the Vehicle ID will be returned. Response time may be impacted by which fields you request.

/vehicles/{vehicleId}/charge-state

Get Vehicle Charge State

/vehicles/{vehicleId}/charging

Start / Stop Charging

/vehicles/{vehicleId}/information

Get Vehicle Information

/vehicles/{vehicleId}/location

Get Vehicle Location

/vehicles/{vehicleId}/odometer

Get Vehicle Odometer

/vehicles/{vehicleId}/smart-charging-policy

Get Vehicle Smart Charging Policy

/vehicles/{vehicleId}/smart-charging-policy

Update Vehicle Smart Charging Policy

• vehicleId (path, required) — ID of the Vehicle

/vehicles/{vehicleId}/watch

Start Watching Vehicle

• vehicleId (path, required) — ID of the Vehicle

/webhooks/firehose

Update Firehose Webhook

/webhooks/firehose/test

Test Firehose Webhook