ZAzaptec
ChargeHistory

Completed sessions (deprecated)

Changed on

Deprecated: Use GET /api/sessions/archived instead.
This endpoint is being phased out with the following timeline:

  • From 2026-08-01, closed sessions older than two years are no longer returned.
  • From 2027-01-01, closed sessions are removed / endpoint sunset.
    Retrieves all completed charge sessions accessible by the current user, matching the provided filters.
    Default page size: 50. Max: 100.
get/api/chargehistory

Request

  • Base URL
    https://api.zaptec.com
  • URL
    https://api.zaptec.com/api/chargehistory
  • Auth
    OAuth 2
    Password
    Token URL: https://api.zaptec.com/oauth/token

Query parameters

InstallationIdstring uuid
UserIdstring uuid
ChargerIdstring uuid
Fromstring date-time
Tostring date-time
GroupBy0 | 1 | 2

0 = group by charger (default), 1 = group by calendar day, 2 = group by user.

0 = Charger

1 = Day

2 = User

DetailLevel0 | 1

Determines the detail level to return.

0 = Summary

1 = EnergyDetails

Bitflag: 0 = session summary (default), 1 = include detailed session energy data.

0 = Summary

1 = EnergyDetails

SortPropertystring

Name of the property used to sort the result.

SortDescendingboolean

Set to true to sort items in descending order.

PageSizeinteger

Number of items to return per page.

PageIndexinteger

The page index to return, first page is 0.

IncludeDisabledboolean

If true, and your user has access, include disabled objects.

Excludestring[]

Get or set a list of item Id's that will be excluded from the result.

PageInfoOnlyboolean

Returns only information about pages and no data info.

Response

OK

pagesinteger
totalCountinteger

Total number of rows across all pages.

messagestring nullable

Changes

  • ba5be4fed4a6Revision changes
    • breaking

      the // response's property type changed from string to object for status (media type: application/json)

    • info

      the endpoint scheme security legacy_auth was removed from the API

    • info

      added the optional property /// to the response with the status (media type: text/plain)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)

    • info

      added the optional property /// to the response with the status (media type: text/plain)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)

    • info

      added the optional property /// to the response with the status (media type: text/plain)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)

    • info

      added the optional property /// to the response with the status (media type: text/plain)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)

    • info

      added the optional property /// to the response with the status (media type: text/plain)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)

    • info

      added the optional property /// to the response with the status (media type: text/plain)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)