Easee State API

openapi: 3.2.0
info:
  title: Easee Cloud State API
  description: OpenAPI Definitions for Easee Cloud APIs.
  version: v1
servers:
- url: https://api.easee.com
security:
- Bearer: []
tags:
- name: State
  description: Read the active scheduling state of a charger.
  x-displayName: State
paths:
  /api/chargers/{chargerId}/schedules:
    get:
      tags:
      - State
      summary: Get scheduling state
      description: Get the charger's scheduling state.
      operationId: GetChargersSchedules
      parameters:
      - name: chargerId
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scheduled_charging_GetScheduleStateResponse'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scheduled_charging_ProblemDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scheduled_charging_ProblemDetails'
components:
  schemas:
    Scheduled_charging_WeeklyScheduleModel:
      type: object
      additionalProperties: false
      required:
      - timezone
      - periods
      properties:
        timezone:
          type: string
          description: IANA time zone identifier for the schedule.
        periods:
          type: array
          description: Collection of  time periods during which charging is permitted.
          items:
            $ref: '#/components/schemas/Scheduled_charging_WeeklySchedulePeriod'
    Scheduled_charging_DailyScheduleModel:
      type: object
      additionalProperties: false
      required:
      - timezone
      - periods
      properties:
        timezone:
          type: string
          description: IANA time zone identifier for the schedule.
        periods:
          type: array
          description: Collection of time periods during which charging is permitted.
          items:
            $ref: '#/components/schemas/Scheduled_charging_DailySchedulePeriod'
    Scheduled_charging_OffPeakRandomizedDelay:
      type: object
      additionalProperties: false
      required:
      - enabled
      properties:
        enabled:
          type: boolean
          description: Whether randomized delay is enabled for the schedule.
        maximumSeconds:
          type:
          - integer
          - 'null'
          description: The configured maximum delay in seconds for the schedule.
          format: int32
        actualSeconds:
          type:
          - integer
          - 'null'
          description: The actual randomized delay offset calculated for this schedule.
          format: int32
    Scheduled_charging_ReadyByTimeEntry:
      type: object
      additionalProperties: false
      required:
      - day
      - time
      properties:
        day:
          $ref: '#/components/schemas/Scheduled_charging_DayOfWeek'
        time:
          type: string
          format: time
    Scheduled_charging_TariffSettings:
      type: object
      additionalProperties: false
      required:
      - fallbackMaximumAmps
      properties:
        priceCap:
          type:
          - number
          - 'null'
          description: The maximum electricity price set for the schedule.
          format: decimal
        readyBy:
          type:
          - array
          - 'null'
          description: The set of ready-by times for the schedule.
          items:
            $ref: '#/components/schemas/Scheduled_charging_ReadyByTimeEntry'
        minimumHours:
          type:
          - number
          - 'null'
          description: Minimum number of hours to charge before the next ready-by time.
          format: decimal
        fallbackMaximumAmps:
          type: integer
          description: Maximum current in amperes allowed once the schedule has elapsed without regeneration.
          format: int32
    Scheduled_charging_DayOfWeek:
      type: string
      description: ''
      x-enumNames:
      - Sunday
      - Monday
      - Tuesday
      - Wednesday
      - Thursday
      - Friday
      - Saturday
      enum:
      - sunday
      - monday
      - tuesday
      - wednesday
      - thursday
      - friday
      - saturday
    Scheduled_charging_DelayedScheduleModel:
      type: object
      additionalProperties: false
      required:
      - timezone
      - startTime
      - maximumAmps
      - elapsed
      properties:
        timezone:
          type: string
          description: IANA time zone identifier for the schedule.
        startTime:
          type: string
          description: Start time of the charging schedule.
          format: time
        maximumAmps:
          type: integer
          description: The maximum electrical current in amperes available to the vehicle throughout the charging schedule.
          format: int32
        elapsed:
          type: boolean
          description: Whether the StartTime has elapsed, after which the MaximumAmps limit applies indefinitely.
    Scheduled_charging_GetScheduleStateResponse:
      type: object
      additionalProperties: false
      required:
      - enabled
      properties:
        enabled:
          type: string
          description: The enabled schedule type or 'none' if no schedule is enabled for the charger.
        delayed:
          description: The stored delayed schedule for the charger.
          oneOf:
          - $ref: '#/components/schemas/Scheduled_charging_DelayedScheduleModel'
        daily:
          description: The stored daily schedule for the charger.
          oneOf:
          - $ref: '#/components/schemas/Scheduled_charging_DailyScheduleModel'
        weekly:
          description: The stored weekly schedule for the charger.
          oneOf:
          - $ref: '#/components/schemas/Scheduled_charging_WeeklyScheduleModel'
        offPeak:
          description: The stored off-peak schedule for the charger.
          oneOf:
          - $ref: '#/components/schemas/Scheduled_charging_OffPeakScheduleModel'
        tariff:
          description: The stored tariff schedule for the charger.
          oneOf:
          - $ref: '#/components/schemas/Scheduled_charging_TariffScheduleModel'
    Scheduled_charging_OffPeakScheduleModel:
      type: object
      additionalProperties: false
      required:
      - timezone
      - template
      - randomizedDelay
      - periods
      properties:
        timezone:
          type: string
          description: IANA timezone identifier of timezone to use for the schedule.
        template:
          type: string
          description: The off-peak template the schedule is based on.
        randomizedDelay:
          description: The configured parameters for randomized delay.
          oneOf:
          - $ref: '#/components/schemas/Scheduled_charging_OffPeakRandomizedDelay'
        periods:
          type: array
          description: Collection of time periods during which charging is permitted.
          items:
            $ref: '#/components/schemas/Scheduled_charging_OffPeakSchedulePeriod'
    Scheduled_charging_TariffScheduleModel:
      type: object
      additionalProperties: false
      required:
      - timezone
      - status
      - settings
      - periods
      properties:
        timezone:
          type: string
          description: IANA time zone identifier for the schedule.
        status:
          type: string
          description: Current lifecycle status of the schedule.
        settings:
          description: The settings the schedule was generated from.
          oneOf:
          - $ref: '#/components/schemas/Scheduled_charging_TariffSettings'
        periods:
          type: array
          description: Collection of absolute time periods during which charging is permitted.
          items:
            $ref: '#/components/schemas/Scheduled_charging_TariffPeriod'
    Scheduled_charging_WeeklySchedulePeriod:
      type: object
      additionalProperties: false
      required:
      - startDay
      - startTime
      - stopDay
      - stopTime
      - maximumAmps
      properties:
        startDay:
          description: The day of week on which the schedule period begins.
          oneOf:
          - $ref: '#/components/schemas/Scheduled_charging_DayOfWeek'
        startTime:
          type: string
          description: The time of day on which the schedule period begins.
          format: time
        stopDay:
          description: The day of week on which the schedule period ends.
          oneOf:
          - $ref: '#/components/schemas/Scheduled_charging_DayOfWeek'
        stopTime:
          type: string
          description: The time of day on which the schedule period ends.
          format: time
        maximumAmps:
          type: integer
          description: The maximum electrical current in amperes permitted by the schedule during this charging period.
          format: int32
    Scheduled_charging_TariffPeriod:
      type: object
      additionalProperties: false
      required:
      - start
      - stop
      - maximumAmps
      properties:
        start:
          type: string
          description: The instant at which charging is permitted to begin.
          format: date-time
        stop:
          type: string
          description: The instant at which charging is no longer permitted.
          format: date-time
        maximumAmps:
          type: integer
          description: The maximum current in amperes permitted during this period.
          format: int32
    Scheduled_charging_OffPeakSchedulePeriod:
      type: object
      additionalProperties: false
      required:
      - startDay
      - startTime
      - stopDay
      - stopTime
      - maximumAmps
      properties:
        startDay:
          description: The day of week on which the schedule period begins.
          oneOf:
          - $ref: '#/components/schemas/Scheduled_charging_DayOfWeek'
        startTime:
          type: string
          description: The time of day on which the schedule period begins.
          format: time
        stopDay:
          description: The day of week on which the schedule period ends.
          oneOf:
          - $ref: '#/components/schemas/Scheduled_charging_DayOfWeek'
        stopTime:
          type: string
          description: The time of day on which the schedule period ends.
          format: time
        maximumAmps:
          type: integer
          description: The maximum electrical current in amperes permitted by the schedule during this charging period.
          format: int32
    Scheduled_charging_DailySchedulePeriod:
      type: object
      additionalProperties: false
      required:
      - startTime
      - stopTime
      - maximumAmps
      properties:
        startTime:
          type: string
          description: Start time of the charging period.
          format: time
        stopTime:
          type: string
          description: Stop time of the charging period.
          format: time
        maximumAmps:
          type: integer
          description: The maximum electrical current in amperes permitted by the schedule during this charging period.
          format: int32
    Scheduled_charging_ProblemDetails:
      type: object
      additionalProperties: {}
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
  securitySchemes:
    Bearer:
      type: apiKey
      description: 'JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"'
      name: Authorization
      in: header
x-provenance:
  method: searched
  source: https://developer.easee.com/reference
  harvested: '2026-10-27'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.easee.com/reference/account_addchargerfavoritebypin.md
  - https://developer.easee.com/reference/account_authenticate.md
  - https://developer.easee.com/reference/account_getchargerfavorites.md
  - https://developer.easee.com/reference/account_getfavorites.md
  - https://developer.easee.com/reference/account_getproductfavorites.md
  - https://developer.easee.com/reference/account_getprofile.md
  - https://developer.easee.com/reference/account_invalidatetoken.md
  - https://developer.easee.com/reference/account_refreshtoken.md
  - https://developer.easee.com/reference/account_removechargerfavorite.md
  - https://developer.easee.com/reference/applyocppforchargerendpoint.md
  - https://developer.easee.com/reference/applyocppforsiteendpoint.md
  - https://developer.easee.com/reference/applyocppforuserchargerendpoint.md
  - https://developer.easee.com/reference/authorizecharging_startcharging.md
  - https://developer.easee.com/reference/charger_acceptchargerinvitationlink.md
  - https://developer.easee.com/reference/charger_addchargeplan.md
  - https://developer.easee.com/reference/charger_addchargertoaccount.md
  - https://developer.easee.com/reference/charger_addweeklychargeschedule.md
  - https://developer.easee.com/reference/charger_createchargerinvitationlink.md
  - https://developer.easee.com/reference/charger_deletechargeplan.md
  - https://developer.easee.com/reference/charger_deleteuserchargeraccess.md
  - https://developer.easee.com/reference/charger_deleteweeklychargeschedule.md
  - https://developer.easee.com/reference/charger_enable_smart_charging.md
  - https://developer.easee.com/reference/charger_getall.md
  - https://developer.easee.com/reference/charger_getcachedchargerconfig.md
  - https://developer.easee.com/reference/charger_getchargeplan.md
  - https://developer.easee.com/reference/charger_getchargerbyid.md
  - https://developer.easee.com/reference/charger_getchargerdetails.md
  - https://developer.easee.com/reference/charger_getchargerinvitationpreview.md
  - https://developer.easee.com/reference/charger_getchargeroperator.md
  - https://developer.easee.com/reference/charger_getchargersite.md
  - https://developer.easee.com/reference/charger_getchargerusers.md
  - https://developer.easee.com/reference/charger_gethourlyaggregatedusage.md
  - https://developer.easee.com/reference/charger_getweeklychargeschedule.md
  - https://developer.easee.com/reference/charger_linkcharger.md
  - https://developer.easee.com/reference/charger_overrideschedule.md
  - https://developer.easee.com/reference/charger_pair_rfid_tag.md
  - https://developer.easee.com/reference/charger_pausesession.md
  - https://developer.easee.com/reference/charger_reboot.md
  - https://developer.easee.com/reference/charger_removechargerfromaccount.md
  - https://developer.easee.com/reference/charger_removechargerinvitationlink.md
  - https://developer.easee.com/reference/charger_removechargeroperator.md
  - https://developer.easee.com/reference/charger_resendchargerinvitationlink.md
  - https://developer.easee.com/reference/charger_resumesession.md
  - https://developer.easee.com/reference/charger_scan_wifi.md
  - https://developer.easee.com/reference/charger_set_cable_lock_state.md
  - https://developer.easee.com/reference/charger_set_dynamic_charger_current.md
  - https://developer.easee.com/reference/charger_set_phase_mode.md
  - https://developer.easee.com/reference/charger_set_wifi_configuration.md
  - https://developer.easee.com/reference/charger_setchargeraccesslevel.md
  - https://developer.easee.com/reference/charger_setchargersetting.md
  - https://developer.easee.com/reference/charger_setchargeschedulefeatures.md
  - https://developer.easee.com/reference/charger_setoperator.md
  - https://developer.easee.com/reference/charger_stop_charging.md
  - https://developer.easee.com/reference/charger_togglecharging.md
  - https://developer.easee.com/reference/charger_update_firmware.md
  - https://developer.easee.com/reference/chargers_deletechargingsession.md
  - https://developer.easee.com/reference/chargers_getlastupdatedchargesession.md
  - https://developer.easee.com/reference/chargers_getongoingsessiondetails.md
  - https://developer.easee.com/reference/chargesession_exportconsumption.md
  - https://developer.easee.com/reference/chargingsessionscharger_getchargersessionsbycharger.md
  - https://developer.easee.com/reference/chargingsessionscharger_getdailysummarybycharger.md
  - https://developer.easee.com/reference/chargingsessionscharger_gethourlysummarybycharger.md
  - https://developer.easee.com/reference/chargingsessionscharger_getlimitchargersessionsbycharger.md
  - https://developer.easee.com/reference/chargingsessionscharger_getmonthlysummarybycharger.md
  - https://developer.easee.com/reference/chargingsessionscharger_gettotalkwhamountbycharger.md
  - https://developer.easee.com/reference/chargingsessionscharger_getyearlysummarybycharger.md
  - https://developer.easee.com/reference/chargingsessionssite_getchargesessionbreakdownbyuser.md
  - https://developer.easee.com/reference/chargingsessionssite_getdailysummarybysite.md
  - https://developer.easee.com/reference/chargingsessionssite_getmonthlysummarybysite.md
  - https://developer.easee.com/reference/chargingsessionssite_getweeklysummarybysite.md
  - https://developer.easee.com/reference/chargingsessionssite_getyearlysummarybysite.md
  - https://developer.easee.com/reference/chargingsessionsuser_getchargersessionsbyuser.md
  - https://developer.easee.com/reference/chargingsessionsuser_getchargesessionbreakdownbyuser.md
  - https://developer.easee.com/reference/chargingsessionsuser_getmonthlysummarybyuser.md
  - https://developer.easee.com/reference/chargingsessionsuser_gettotalkwhamountbyuser.md
  - https://developer.easee.com/reference/chargingsessionsuser_getweeklysummarybyuser.md
  - https://developer.easee.com/reference/chargingsessionsuser_getyearlysummarybyuser.md
  - https://developer.easee.com/reference/deletechargersschedulesdaily.md
  - https://developer.easee.com/reference/deletechargersschedulesdelayed.md
  - https://developer.easee.com/reference/deletechargersschedulesweekly.md
  - https://developer.easee.com/reference/disableocppforchargerendpoint.md
  - https://developer.easee.com/reference/disableocppforuserchargerendpoint.md
  - https://developer.easee.com/reference/easeekeys_addeaseekey.md
  - https://developer.easee.com/reference/easeekeys_deleteeaseekey.md
  - https://developer.easee.com/reference/easeekeys_geteaseekeys.md
  - https://developer.easee.com/reference/easeekeys_updateeaseekey.md
  - https://developer.easee.com/reference/equalizer_configureallocatedcurrent.md
  - https://developer.easee.com/reference/equalizer_configuremetertype.md
  - https://developer.easee.com/reference/equalizer_geequalizerconfig.md
  - https://developer.easee.com/reference/equalizer_getdetailedequalizer.md
  - https://developer.easee.com/reference/equalizer_getequalizer.md
  - https://developer.easee.com/reference/equalizer_getequalizersite.md
  - https://developer.easee.com/reference/equalizer_reboot.md
  - https://developer.easee.com/reference/equalizer_updatefirmware.md
  - https://developer.easee.com/reference/getchargerconnectiondetailsendpoint.md
  - https://developer.easee.com/reference/getchargersschedules.md
  - https://developer.easee.com/reference/getchargersschedulesdaily.md
  - https://developer.easee.com/reference/getchargersschedulesdelayed.md
  - https://developer.easee.com/reference/getchargersschedulesweekly.md
  - https://developer.easee.com/reference/getobservations.md
  - https://developer.easee.com/reference/getoperatorconnectiondetailsendpoint.md
  - https://developer.easee.com/reference/getuserchargerconnectiondetailsendpoint.md
  - https://developer.easee.com/reference/getworkflowresultsendpoint.md
  - https://developer.easee.com/reference/getworkflowstreamendpoint.md
  - https://developer.easee.com/reference/lifetimeenergyreporting_configure.md
  - https://developer.easee.com/reference/lifetimeenergyreporting_getchargerbyid.md
  - https://developer.easee.com/reference/lifetimeenergyreporting_getdailyforperiod.md
  - https://developer.easee.com/reference/lifetimeenergyreporting_gethourlyforperiod.md
  - https://developer.easee.com/reference/lifetimeenergyreporting_getmonthlyforperiod.md
  - https://developer.easee.com/reference/lifetimeenergyreporting_getyearlyforperiod.md
  - https://developer.easee.com/reference/partners_deletecustomendpoint.md
  - https://developer.easee.com/reference/partners_getallcustomendpoints.md
  - https://developer.easee.com/reference/partners_getcustomendpointsonsite.md
  - https://developer.easee.com/reference/partners_getocppconfig.md
  - https://developer.easee.com/reference/partners_saveocppconfig.md
  - https://developer.easee.com/reference/partners_setcustomendpoint.md
  - https://developer.easee.com/reference/postchargerconnectiondetailsendpoint.md
  - https://developer.easee.com/reference/postchargersschedulesdaily.md
  - https://developer.easee.com/reference/postchargersschedulesdailydisable.md
  - https://developer.easee.com/reference/postchargersschedulesdailyenable.md
  - https://developer.easee.com/reference/postchargersschedulesdelayed.md
  - https://developer.easee.com/reference/postchargersschedulesdelayeddisable.md
  - https://developer.easee.com/reference/postchargersschedulesdelayedenable.md
  - https://developer.easee.com/reference/postchargersschedulesweekly.md
  - https://developer.easee.com/reference/postchargersschedulesweeklydisable.md
  - https://developer.easee.com/reference/postchargersschedulesweeklyenable.md
  - https://developer.easee.com/reference/postoperatorconnectiondetailsendpoint.md
  - https://developer.easee.com/reference/postuserchargerconnectiondetailsendpoint.md
  - https://developer.easee.com/reference/resources_getactivecountries.md
  - https://developer.easee.com/reference/resources_getallcountries.md
  - https://developer.easee.com/reference/resources_getcurrencies.md
  - https://developer.easee.com/reference/resources_getobservationproperties.md
  - https://developer.easee.com/reference/site_acceptsiteinvitationlink.md
  - https://developer.easee.com/reference/site_attachchargerstobackplates.md
  - https://developer.easee.com/reference/site_createsiteinvitationlink.md
  - https://developer.easee.com/reference/site_deleteaccesslevelforchargers.md
  - https://developer.easee.com/reference/site_deletecircuit.md
  - https://developer.easee.com/reference/site_deletesite.md
  - https://developer.easee.com/reference/site_deletesiteinvitation.md
  - https://developer.easee.com/reference/site_deletesitepermission.md
  - https://developer.easee.com/reference/site_deletesiteuser.md
  - https://developer.easee.com/reference/site_disablecontrolaccess.md
  - https://developer.easee.com/reference/site_getall.md
  - https://developer.easee.com/reference/site_getchargerenergybysite.md
  - https://developer.easee.com/reference/site_getchargers.md
  - https://developer.easee.com/reference/site_getcircuitattachedsite.md
  - https://developer.easee.com/reference/site_getcircuitsettings.md
  - https://developer.easee.com/reference/site_getdynamiccircuitcurrent.md
  - https://developer.easee.com/reference/site_geteaseecontroluiaccessrequest.md
  - https://developer.easee.com/reference/site_getmonthlyconsumptionbyuser.md
  - https://developer.easee.com/reference/site_getmonthlyconsumptionbyuserandcharger.md
  - https://developer.easee.com/reference/site_getsitebyid.md
  - https://developer.easee.com/reference/site_getsiteinvitationpreview.md
  - https://developer.easee.com/reference/site_getsitestate.md
  - https://developer.easee.com/reference/site_getsiteusers.md
  - https://developer.easee.com/reference/site_getyearlyconsumptionbyuser.md
  - https://developer.easee.com/reference/site_getyearlyconsumptionbyuserandcharger.md
  - https://developer.easee.com/reference/site_removeequalizerfromsite.md
  - https://developer.easee.com/reference/site_requestcontrolaccess.md
  - https://developer.easee.com/reference/site_requestsiteaccess.md
  - https://developer.easee.com/reference/site_resendsiteinvitationlink.md
  - https://developer.easee.com/reference/site_savechargingprice.md
  - https://developer.easee.com/reference/site_setaccesslevel.md
  - https://developer.easee.com/reference/site_setaccesslevelforchargers.md
  - https://developer.easee.com/reference/site_setcircuit.md
  - https://developer.easee.com/reference/site_setcircuitmaster.md
  - https://developer.easee.com/reference/site_setcircuitsettings.md
  - https://developer.easee.com/reference/site_setdynamiccircuitcurrent.md
  - https://developer.easee.com/reference/site_setsiteowner.md
  - https://developer.easee.com/reference/site_updatechargers.md
  - https://developer.easee.com/reference/site_updatecircuitcollection.md
  - https://developer.easee.com/reference/site_updatecircuits.md
  - https://developer.easee.com/reference/site_updatesitepatch.md
  - https://developer.easee.com/reference/site_updatesitepermission.md
  - https://developer.easee.com/reference/siteintegration_setaccesslevel.md
  merge:
    pages: 175
    deduped: 474
    conflicts_kept_first: 0