# List charging sub sessions List all charging sub sessions visible to the authenticated client. Endpoint: GET /charging_sub_sessions Version: 2.0 Security: oauth2 ## Header parameters: - `EvEnergy-Version` (number) Specify the version of this endpoint to use. Enum: 2 ## Query parameters: - `page_before` (string) Return results from the page after this ID. Example: "xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR" - `page_after` (string) Return results from the page before this ID. Example: "xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR" - `page_size` (integer) Specify the number of results to return per page. Example: 10 - `expand` (array) Specify a url field to expand into a nested resource. Enum: "evse", "evse.latest_status_log", "evse.model", "evse.model.make", "evse.user", "vehicle", "vehicle.latest_status_log", "vehicle.trim", "vehicle.trim.model", "vehicle.trim.model.make", "vehicle.user", "energy_usage", "schedules", "tariff", "tariff.supplier" - `evse_id` (string) Filter to only resources related to the given EVSE. Example: "evse01HSH04KDEWF6Z4DB2J77J74K5" - `vehicle_id` (string) Filter to only resources related to the given Vehicle. Example: "vhcl01HRFF3SEVSCRAV9B3CHVDFN0H" - `user_id` (string) Filter collection to only resources owned by a specific user. Example: "me" - `energy_delivered_watt_hours__gte` (integer) Filters for values greater than or equal to a value. Example: 500 - `energy_delivered_watt_hours__lte` (integer) Filters for values less than or equal to a value. Example: 500 - `is_finished` (boolean) Filters for sessions that are finished. - `mode` (string) Filters sessions to only return sessions with this mode. Enum: "SMART", "BOOST", "UNMANAGED_HOME", "UNMANAGED_OTG", "MANAGED_OTG" - `start__gt` (string) Only return sessions that started after the passed date - `start__lt` (string) Only return sessions that started before the passed date - `end__gt` (string) Only return sessions that ended after the passed date - `end__lt` (string) Only return sessions that ended before the passed date ## Response 200 fields (application/json): - `id` (string) Unique identifier for the given Charging sub-session. Example: "csub01HSH04KDEWF6Z4DB2J77J74K5" - `url` (string) Example: "https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5" - `start` (string) - `end` (string,null) - `mode` (any) The type of scheduling applied during this period. smart: Actively optimised charging boost: Charge immediately unmanaged: No optimisation Enum: "SMART", "BOOST", "UNMANAGED_HOME", "UNMANAGED_OTG", "MANAGED_OTG" - `vehicle` (any) - `evse` (any) - `energy_delivered_watt_hours` (integer) Net energy delivered to the vehicle during this sub-session in Wh. Example: 2300 - `cost` (integer,null) Example: 634 - `location` (object) - `location.name` (string) Example: "Home" - `location.coordinates` (object) Can be null - `location.coordinates.latitude` (number, required) Example: 51.52576576674041 - `location.coordinates.longitude` (number, required) Example: -0.08366433371722264 - `location.postal_code` (string,null) - `location.address_1` (string,null) - `location.timezone` (string,null) IANA timezone name for the charging location. Example: "Europe/London" - `percentage_added` (number,null) Example: 30 - `currency` (string) Example: "GBP" - `savings_cost` (integer,null) Cost Savings in Minor Unit of Currency. - `savings_co2_grams` (integer,null) Savings of Carbon in Grams of CO2. - `incentive_earned` (integer,null) Incentive earned in minor unit of currency. Example: 99 - `total_co2_grams` (integer,null) Estimated total CO2 emissions of this session in grams - `co2_intensity_grams_per_kilowatt_hour` (integer,null) Estimated CO2 emissions per unit of electricity in grams per kilowatt hour - `co2_intensity_classification` (any) Classification of the estimated CO2 intensity value. Can be null. Enum: "very low", "low", "moderate", "high", "very high" - `cost_per_kilowatt_hour` (integer,null) Average cost per kilowatt hour of energy delivered during this charging session - `total_points` (integer) Number of smart points earning during this charging session - `total_points_missed` (integer,null) Difference between the number of smart points earned in this session and the number that would have been earned by Smart charging - `duration_minutes` (integer) How long the vehicle was actively charging for, to the nearest minute - `grid_energy_delivered_watt_hours` (integer) Grid energy delivered during this charging sub-session in watt hours (Wh). - `solar_energy_delivered_watt_hours` (integer) Solar energy delivered during this charging sub-session in watt hours (Wh). - `labels` (array,null) Labels categorizing this charging session (e.g., service territory, pricing period). Enum: "OUTSIDE", "OFF_PEAK", "SUMMER_PEAK", "MIXED", "OTHER", "PRIMARY", "AWAY", "CONED", "ORU" - `energy_usage` (any) A link to more detailed information about energy usage during the charging sub-session. Can be expanded. - `schedules` (any) A link to schedule information for the charging sub-session. Can be expanded. - `tariff` (any) The electricity import tariff. Expandable with ?expand=tariff. Requires tariff:read scope. - `grid_energy_delivered` (string) Use grid_energy_delivered_watt_hours instead - `solar_energy_delivered` (string) Use solar_energy_delivered_watt_hours instead. ## Response 400 fields (application/problem+json): - `type` (string) Example: "https://api.ev.energy/v2/problems/example-problem/" - `status` (number) Example: 400 - `title` (string, required) Example: "Short description" - `detail` (string, required) Example: "Long, more specific description." - `instance` (string) Example: "https://api.ev.energy/v2/users/user01HN2P75GBNFRJPCZJXEFVXH5E" - `notification` (object) Something that the user should be informed about. - `notification.id` (string, required) Unique identifier for the Notification Example: "notf67O36PLTFDB57M0E5L33JZLGM0" - `notification.url` (string, required) Example: "https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0" - `notification.message_id` (string, required) Internal identifier for this notification type. E.g. 'ERR0023' - `notification.category` (any, required) Category of this notification type Enum: "ACTIONABLE", "SERVICE", "RETRY", "MARKETING", "INTERNAL" - `notification.event_time` (string, required) The timestamp of the event described by this notification - `notification.short_text_title` (string, required) Short title for the notification - `notification.short_text_body` (string, required) Short description of the event being notified - `notification.detail_page_title` (string) Title of a help page giving more information about this notification - `notification.detail_page_body` (string) Text of a help page giving more information about this notification - `notification.external_link` (string,null) URL of a web page giving further information about this notification - `notification.external_button_label` (string) Text to be displayed on a button leading to the external_link location - `notification.read_at` (string) When the user examined the contents of this notification - `notification.resolved_at` (string) When the problem associated with this notification was resolved ## Response 401 fields (application/problem+json): - `status` (number) Example: 401 - `title` (string, required) Example: "Unauthorized" - `detail` (string, required) Example: "Authentication credentials were not provided." ## Response 403 fields (application/problem+json): - `status` (number) Example: 403 - `title` (string, required) Example: "Forbidden" - `detail` (string, required) Example: "You do not have permission to perform this action." ## Response 406 fields (application/problem+json): - `status` (number) Example: 406 - `title` (string, required) Example: "Not Acceptable" - `detail` (string, required) Example: "Could not satisfy the request Accept header." ## Response 429 fields (application/problem+json): - `type` (string) Example: "https://api.ev.energy/v2/problems/example-problem/" - `status` (number) Example: 400 - `title` (string, required) Example: "Short description" - `detail` (string, required) Example: "Long, more specific description." - `instance` (string) Example: "https://api.ev.energy/v2/users/user01HN2P75GBNFRJPCZJXEFVXH5E" - `notification` (object) Something that the user should be informed about. - `notification.id` (string, required) Unique identifier for the Notification Example: "notf67O36PLTFDB57M0E5L33JZLGM0" - `notification.url` (string, required) Example: "https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0" - `notification.message_id` (string, required) Internal identifier for this notification type. E.g. 'ERR0023' - `notification.category` (any, required) Category of this notification type Enum: "ACTIONABLE", "SERVICE", "RETRY", "MARKETING", "INTERNAL" - `notification.event_time` (string, required) The timestamp of the event described by this notification - `notification.short_text_title` (string, required) Short title for the notification - `notification.short_text_body` (string, required) Short description of the event being notified - `notification.detail_page_title` (string) Title of a help page giving more information about this notification - `notification.detail_page_body` (string) Text of a help page giving more information about this notification - `notification.external_link` (string,null) URL of a web page giving further information about this notification - `notification.external_button_label` (string) Text to be displayed on a button leading to the external_link location - `notification.read_at` (string) When the user examined the contents of this notification - `notification.resolved_at` (string) When the problem associated with this notification was resolved