Skip to main content

Get chargers​

x-ms-visibility: "important"

Retrieve a list of all chargers associated with the user.

Query Parameters
    page int32

    Page to be fetched. Default: 1

    limit int32

    Limit (No. of records per page). Max value: 100. Default: 100.

    sortKey string

    Sort field to be used. Default: 'ChargerId'

    sortDescending boolean

    Set to 'true' to sort descending based on sort key. Default: 'false' Available sort keys: chargerId, name, lastSeen, activeConnection, model, manufacturer.

    siteId int32

    Filter chargers by site ID.

    includeSubsites boolean

    Include chargers from subsites.

    externalSiteId string

    Filter chargers by external site ID.

    manufacturer string

    Filter chargers by manufacturer.

    model string

    Filter chargers by model.

    socketState string

    Filter chargers by socket state.

    search string

    Free text filter for charger name, manufacturer, model, address.

    includeConfigs boolean

    Include charger configurations in the response.

Responses

List of chargers accessible by the user.

Schema
    page int32
    limit int32
    totalRecords int32
    hasNextPage boolean
    hasPreviousPage boolean
    items object[]
  • Array [
    • id int64
    chargerId string
    name string
    state int32

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]

    Default value: 0

    lastMessage string
    lastSeen date-time nullable
    siteId int64
    siteName string
    model string
    manufacturer string
    firmware string
    serial string
    activeConnection boolean nullable
    iccid string
    imsi string
    meterType string
    meterSerialNumber string
    pushIntegrationEnabled boolean nullable
    chargerSpecificMessageStructure boolean nullable
    evseId string
    splitEvseBySocket boolean nullable
    physicalReference string
    sockets object[]
  • Array [
    • type string
    maxPower string
    status string
    id int32
    name string
    deviceEvseId int32 nullable
    deviceConnectorId int32 nullable
    format string
    socketPowerType string
    maxWatts int32 nullable
    maxVoltage int32 nullable
    maxAmperage int32 nullable
    phaseRotation string
    termsAndConditions uri
    lastUpdated date-time
    chargingStationEvseId int32 nullable
    parkingPlace string
  • ]
    • location object
    latitude double
    longitude double
    streetAddress string
    streetNumber string
    houseLetter string
    postalNumber string
    city string
    area string
    country string
    capabilities string[]

    Possible values: [CHARGING_PROFILE_CAPABLE, CHARGING_PREFERENCES_CAPABLE, CHIP_CARD_SUPPORT, CONTACTLESS_CARD_SUPPORT, CREDIT_CARD_PAYABLE, DEBIT_CARD_PAYABLE, PED_TERMINAL, REMOTE_START_STOP_CAPABLE, RESERVABLE, RFID_READER, START_SESSION_CONNECTOR_REQUIRED, TOKEN_GROUP_CAPABLE, UNLOCK_CAPABLE]

    chargerConfigurations object[]
  • Array [
    • configName string
    configValue string
    canBeChanged boolean
  • ]
    • ongoingTransactions object[]
  • Array [
    • socketId int32
    transactionId int32
    evseTransactionId string
  • ]
    • customProperties object
    property name* string
    integrationRelays string[]
    metadata string[]
    installationDate date-time nullable
    parkingPlace string
    serviceCompany string
    serviceContactPerson string
    servicePhoneNumber string
    serviceEmail string
    notes string
  • ]
Loading...