Session
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
Start Session
Initiates a new charging session at a charge point. The session will begin immediately if the charge point is available and properly configured. Returns the session object with a unique identifier that can be used for subsequent operations like monitoring status or stopping the session.
Header parameters1
Optional idempotency key to safely retry requests. Provide a unique string (e.g., UUID) to ensure that retrying a request doesn't create duplicate resources. The same key will return the same result for up to 24 hours.
Request bodyREQUIREDapplication/json
UUID of the charge point to start a session on.
Optional external reference or identifier for this session (e.g., customer reference, transaction ID).
201Successfully returns the charging session object with complete details including status, timing, and billing information. application/json
Timestamp when the session record was created in the system
Timestamp when the session record was last updated
Timestamp when the charging session actually started
ISO 4217 currency code for the cost
Timestamp when the session was soft-deleted (if applicable)
Optional external reference or identifier provided when starting the session
Timestamp when the charging session was stopped
Number of times this session has been settled. 1 on first settlement, increments on each correction. Absent for unsettled sessions.
Total energy consumed during the session in kilowatt-hours
Total cost of the charging session in the specified currency
Current state of the charging session
stateChangesobject[]History of state transitions for this session, ordered chronologically
History of state transitions for this session, ordered chronologically
Timestamp when the state transition occurred
Machine-readable code for why this transition happened (present for Failed/Abandoned transitions), e.g. start_not_confirmed
The new state after this transition
Unique identifier of this state change event
Reference to the session that changed state
Unique identifier of the charging session
Unique identifier of the integration (partner/tenant) that owns this session
Unique identifier of the charge point where the session is taking place
Reference to the authorization used to start this session
400Bad Request - The request was unacceptable, often due to missing or invalid parameters. Response follows RFC 7807 Problem Details format with structured error information. application/json
Stable error identifier for programmatic handling (e.g., 'validation.failed', 'resource.not_found')
500Internal Server Error - Something went wrong on our end. These errors are rare and typically indicate a temporary issue with our servers. Response follows RFC 7807 Problem Details format. May include 'Retry-After' header for transient errors. application/json
List Sessions
Returns a paginated list of charging sessions associated with your account. Sessions are returned in reverse chronological order (most recent first). Use the limit and offset parameters to control pagination. The response includes pagination metadata (total count, page number, etc.).
Query parameters2
Number of sessions to return per request. Default is 50 if not specified. Maximum is 1000.
50Number of sessions to skip before returning results. Used for pagination. Default is 0.
0200Successfully returns a paginated list of charging sessions in reverse chronological order. Includes pagination metadata with total count, current page, offset, and limit. application/json
metadataobjectPagination metadata including total count, page number, offset, and limit
Pagination metadata including total count, page number, offset, and limit
sessionsobject[]Array of charging sessions ordered by creation time (most recent first)
Array of charging sessions ordered by creation time (most recent first)
Timestamp when the session record was created in the system
Timestamp when the session record was last updated
Timestamp when the charging session actually started
ISO 4217 currency code for the cost
Timestamp when the session was soft-deleted (if applicable)
Optional external reference or identifier provided when starting the session
Timestamp when the charging session was stopped
Number of times this session has been settled. 1 on first settlement, increments on each correction. Absent for unsettled sessions.
Total energy consumed during the session in kilowatt-hours
Total cost of the charging session in the specified currency
Current state of the charging session
stateChangesobject[]History of state transitions for this session, ordered chronologically
History of state transitions for this session, ordered chronologically
Timestamp when the state transition occurred
Machine-readable code for why this transition happened (present for Failed/Abandoned transitions), e.g. start_not_confirmed
The new state after this transition
Unique identifier of this state change event
Reference to the session that changed state
Unique identifier of the charging session
Unique identifier of the integration (partner/tenant) that owns this session
Unique identifier of the charge point where the session is taking place
Reference to the authorization used to start this session
400Bad Request - The request was unacceptable, often due to missing or invalid parameters. Response follows RFC 7807 Problem Details format with structured error information. application/json
Stable error identifier for programmatic handling (e.g., 'validation.failed', 'resource.not_found')
500Internal Server Error - Something went wrong on our end. These errors are rare and typically indicate a temporary issue with our servers. Response follows RFC 7807 Problem Details format. May include 'Retry-After' header for transient errors. application/json
Get Session
Retrieves the details of an existing charging session using its unique identifier. This returns comprehensive information including session status, energy consumption, duration, and billing details.
Path parameters1
Unique identifier of the charging session
200Successfully returns the charging session object with complete details including status, timing, and billing information. application/json
Timestamp when the session record was created in the system
Timestamp when the session record was last updated
Timestamp when the charging session actually started
ISO 4217 currency code for the cost
Timestamp when the session was soft-deleted (if applicable)
Optional external reference or identifier provided when starting the session
Timestamp when the charging session was stopped
Number of times this session has been settled. 1 on first settlement, increments on each correction. Absent for unsettled sessions.
Total energy consumed during the session in kilowatt-hours
Total cost of the charging session in the specified currency
Current state of the charging session
stateChangesobject[]History of state transitions for this session, ordered chronologically
History of state transitions for this session, ordered chronologically
Timestamp when the state transition occurred
Machine-readable code for why this transition happened (present for Failed/Abandoned transitions), e.g. start_not_confirmed
The new state after this transition
Unique identifier of this state change event
Reference to the session that changed state
Unique identifier of the charging session
Unique identifier of the integration (partner/tenant) that owns this session
Unique identifier of the charge point where the session is taking place
Reference to the authorization used to start this session
400Bad Request - The request was unacceptable, often due to missing or invalid parameters. Response follows RFC 7807 Problem Details format with structured error information. application/json
Stable error identifier for programmatic handling (e.g., 'validation.failed', 'resource.not_found')
404Not Found - The requested resource does not exist. This could be due to an incorrect ID, or the resource may have been deleted. Response follows RFC 7807 Problem Details format. application/json
500Internal Server Error - Something went wrong on our end. These errors are rare and typically indicate a temporary issue with our servers. Response follows RFC 7807 Problem Details format. May include 'Retry-After' header for transient errors. application/json
Stop Session
Terminates an active charging session immediately. This action cannot be undone once executed. Only sessions with 'Started' status can be stopped. The final billing and energy consumption data will be calculated and made available through the session object.
Path parameters1
Unique identifier of the charging session
Header parameters1
Optional idempotency key to safely retry requests. Provide a unique string (e.g., UUID) to ensure that retrying a request doesn't create duplicate resources. The same key will return the same result for up to 24 hours.
202Accepted
400Bad Request - The request was unacceptable, often due to missing or invalid parameters. Response follows RFC 7807 Problem Details format with structured error information. application/json
Stable error identifier for programmatic handling (e.g., 'validation.failed', 'resource.not_found')