Charging stations
Lists charging sessions that took place on the account's charge points (the operator view): who charged, energy delivered, duration and revenue. Returns live (in-progress) and recent (completed) sessions. Callers with account-level charge-point session read access see sessions on all the account's charge points, except a colleague's employee-reimburse (home) charge point; other callers see only sessions at locations linked to them (e.g. their own home charge point). For sessions the account's users ran at other operators, use charging-cards-sessions.
Input
Output3
liveobject[]REQUIRED
chargePointobjectREQUIRED
Canonical charge-point identifier — same value used by every charge-points-* tool.
driverobject | nullREQUIRED
Token visual number — the non-secret card/token identifier.
Hashed token uid; the raw uid is secret and never returned.
revenueobjectREQUIRED
locationobject | nullREQUIRED
recentobject[]REQUIRED
chargePointobjectREQUIRED
Canonical charge-point identifier — same value used by every charge-points-* tool.
driverobject | nullREQUIRED
Token visual number — the non-secret card/token identifier.
Hashed token uid; the raw uid is secret and never returned.
revenueobjectREQUIRED
locationobject | nullREQUIRED
Returns an account-wide charge-point summary: how many charge points and locations the account operates, sessions currently active on them, and current-month CPO session totals (energy, duration), plus a list of the account's charge points (up to 50). Callers with account-level charge-point read access see the list; other callers see the aggregate stats only.
Input
Output3
statsobject | nullREQUIRED
Which charge points the list and these counts cover. "account": every charge point on the account, except a colleague's employee-reimburse (home) charge point, which is never shown. "own": only locations linked to this caller. An empty list under "own" means the caller has no charge point of their own, NOT that access was refused.
True when more charge points are in scope than the list returns. The counts still cover all of them.
Distinct locations the account's charge points sit at.
Charge points with connectivityState "connected".
Charge points not currently connected.
Charge points offline, reboot-required or disabled.
Charge points where roaming is on, i.e. a charge card from outside this platform is accepted. This is NOT a count of publicly listed or map-visible charge points; that is the location publishingMode, a separate setting.
Total active (unresolved) issues across the account's charge points.
Connector count keyed by status.
CPO sessions currently in ACTIVE status, within what this caller may see (see sessions).
sessionsobjectREQUIREDCompleted CPO session totals for the current calendar month, windowed on endedAt (the billing date, so a session spanning a month boundary counts in the month it ended). Scoped to what this caller may see: with account-level cpoSessions read, every location except a colleague's employee-reimburse charge point; without it, only locations linked to the caller. Includes excluded sessions, so these totals can read higher than the CPO dashboard.
Completed CPO session totals for the current calendar month, windowed on endedAt (the billing date, so a session spanning a month boundary counts in the month it ended). Scoped to what this caller may see: with account-level cpoSessions read, every location except a colleague's employee-reimburse charge point; without it, only locations linked to the caller. Includes excluded sessions, so these totals can read higher than the CPO dashboard.
currentMonthobjectREQUIRED
revenueobject[]REQUIREDTotal session cost this month, grouped by currency.
Total session cost this month, grouped by currency.
chargePointsobject[]REQUIRED
Canonical station identifier; round-trip unchanged to other charge-points-* tools.
Normalized EVSE id when assigned; null during setup.
Stored EVSE id as shown to humans; may contain separators.
Charge point manufacturer
Charge point model
Whether charge cards from outside this platform are accepted here, i.e. whether roaming is on, so a visiting driver can charge. Mechanically it is the fallback that authorises a token belonging to no access group. Despite the name this is not a statement about the location being publicly listed or findable on a map, which is a separate location setting. It cannot be enabled on a location where nobody is reimbursed. Stored per charge point but edited at location level and propagated down, so charge points on one location can in principle disagree.
ISO timestamp the charge point was last seen.
locationobject | nullREQUIRED
Count of active (unresolved) issues on this charge point.
connectorsobject[]REQUIRED
Maximum power in kW
available: ready for a new session. preparing: vehicle plugged in, not yet charging. ev-connected: vehicle connected but charging not started. charging: actively delivering energy. occupied: connector in use but not charging. suspended-evse: charging paused by the station. suspended-ev: charging paused by the vehicle. idle: connected but no energy flow. finishing: session ending, wrapping up. unavailable: connector not available for use (e.g. maintenance). faulted: error state, may need physical intervention. reserved: reserved for a specific user. unknown: status could not be determined.
Whether a tariff is configured for this connector.