List charging sessions​

GET
/sessions

Returns charging sessions in the selected organization. Filter and sort the results, include related entities, or request aggregates before paging.

Use cases

  • Monitor active sessions or review historical charging activity.
  • Build energy, cost, or session-count summaries.

Related endpoints

  • GET /sessions/{chargingSessionId} — inspect one session.
  • GET /sessions/{chargingSessionId}/meter-data — retrieve its meter readings.
  • POST /sessions/{chargingSessionId}/stop — stop an in-progress session.

Authorizations​

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters​

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-02"
Pattern
^\d{4}-\d{2}-\d{2}$
organization-id*

Routes the request to the organization named by this ID. The bearer token must be authorized for that organization.

Type
string
Required
Example"3b241101-e2bb-4255-8caf-4136c566a962"
Min Length
1
Max Length
40
x-ignore-forbidden-include

If an include requests data the token cannot view, set this to true or 1 to omit that included field instead of returning 403. This does not grant the missing permission.

Type
string
Valid values
"1""true"
Examples
"true""1"

Query Parameters

filter

Filter charging sessions by these fields: id, chargerId, connectorId, userId, status, createdAt, startedAt. Use : for equality, <> for inequality, < and > for strict comparisons, <: and >: for inclusive comparisons, and ~ for substring matching. Use semicolons to AND conditions; multiple filter entries are OR alternatives.

Example"createdAt>:2026-01-01T00:00:00.000Z"
sort

Sort by up to 3 fields from: id, chargerId, connectorId, userId, status, createdAt, startedAt. Prefix with + for ascending or - for descending, and separate fields with commas.

Type
string
Example"-createdAt"
Min Length
1
Max Length
256
include

Related entities to include in the response. Allowed fields: charger, location, authorization Use comma-separated selectors: a bare field includes all of its values, while field.subfield selects only that nested value.

Type
string
Example"charger.name,location.name"
Min Length
1
Max Length
512
aggregate

Aggregation functions to apply. Supported functions: count, sum, avg, min, max. Format: function:field (e.g. count:energy, sum:price)

Type
string
Example"count:energy,sum:price"
Min Length
1
Max Length
512
aggregate_interval

Time bucket interval (e.g. 1m, 2h, 1d). Required when aggregate is set. Use a positive integer followed by s, m, h, d, or w for seconds, minutes, hours, days, or weeks. Example: 1h.

Type
string
Example"1h"
Min Length
2
Max Length
16
page

1-based page number; defaults to 1.

Type
integer
Example2
Default
1
Exclusive Minimum
0
Maximum
4294967295
per_page

Maximum records returned per page. Defaults to 10 and cannot exceed 100.

Type
integer
Example25
Default
10
Exclusive Minimum
0
Maximum
100

Responses​

success.chargingSession.list

application/json

Number of sessions matching the filters before pagination.

Minimum0
Maximum9007199254740991

Playground​

Authorization
Headers
Variables
Key
Value

Samples​