Sites

Retrieve a single (charge) site

Changed on

Required scope: charge-points:read </br>Organization authorization: supported

get/api/v1/sites/{siteId}

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/sites/{siteId}
  • Auth
    HTTP bearer

Path parameters

siteIdinteger required

Response

Site with provided id

idinteger

Id of the site

teamIdinteger nullable

Id of the team that has access to the site

partnerExternalIdstring nullable

External Id of this entity, managed by you.

partnerCustomPayloadobject nullable

Custom JSON payload for this entity, managed by you.</br>Note: the expected shape is a flat JSON object with named keys.

namestring required

Name of the site

createdAtstring date-time required

Creation date of this charging site

updatedAtstring date-time required

Date this charging site was last updated

deletedAtstring date-time nullable

Date this charging site was deleted

chargePointCountinteger

Number of charge points at this site

activeChargePointCountinteger

Number of active charge points at this site

availableChargePointCountinteger

Number of available charge points at this site

maxKWnumber double nullable

Deprecated (will be removed by 01.04.24), use maxKw field instead.

maxKwnumber double nullable

Max KW available at this site.

type'ac' | 'dc' nullable

Type of charge points at this site (AC / DC)

visibility'private' | 'public' required

Indicates if this site is public or private. Controls who can charge at the site; independent of showOnMap.

showOnMapboolean nullable

Whether this site is visible on the consumer map. Independent of visibility: a public site can still be hidden, and a private site can still be shown.

driverSupportVisibility'inherit' | 'public' | 'off' required

Whether Monta's AI Driver Support may reach drivers at this site.</br>- inherit — follow the site's visibility: a public site is reachable, a private site is not.</br>- public — always reachable, even when the site's visibility is private.</br>- off — never reachable, even when the site is public.

notestring nullable

A note you have entered for this site, e.g. via our Portal.

Example response

{
  "id": 1,
  "teamId": 13,
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {
    "internalId": "ACME-12345",
    "department": "Fleet"
  },
  "name": "Monta CPH HQ",
  "operator": {
    "id": 14,
    "name": "Monta",
    "identifier": "monta",
    "partnerId": 1,
    "vatNumber": "FOO-123-ABC"
  },
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z",
  "deletedAt": "2022-05-12T16:56:45.99Z",
  "chargePointCount": 42,
  "activeChargePointCount": 33,
  "availableChargePointCount": 4,
  "maxKW": 150,
  "maxKw": 150,
  "type": "ac",
  "visibility": "public",
  "showOnMap": true,
  "driverSupportVisibility": "inherit",
  "note": "In order to access this site enter 0000 as code at the gate.",
  "location": {
    "coordinates": {
      "latitude": 55.6760968,
      "longitude": 12.5683371
    },
    "addressLabel": "Strandboulevarden 122, 5. sal, 2100 København, Denmark",
    "address": {
      "address1": "Strandboulevarden 122",
      "address2": "København",
      "address3": "5. sal",
      "zip": "2100",
      "city": "Copenhagen",
      "province": "Lombardy",
      "countrySubdivisionCode": "US-GA",
      "country": "Denmark",
      "countryAreaId": 1
    }
  },
  "connectors": [
    {
      "id": 1,
      "identifier": "ccs",
      "name": "CCS"
    }
  ],
  "metadata": {
    "atm": true,
    "driverLounge": true,
    "parkingArea": true,
    "powerSupply": true,
    "vendingMachine": true,
    "wifi": true,
    "toilets": 2,
    "cafe": true,
    "hotel": true,
    "museum": true,
    "park": true,
    "recreationArea": true,
    "restaurant": true,
    "bikeSharing": true,
    "busStop": true,
    "metroStation": true,
    "tramStop": true,
    "truckDealership": true,
    "truckParking": true,
    "truckWash": true,
    "accessControlledArea": true,
    "entryGate": true,
    "floodLighting": true,
    "licensePlateRecognition": true,
    "perimeterFence": true,
    "energyMix": {
      "isGreenEnergy": true,
      "energySources": [
        {
          "percentage": 40
        }
      ],
      "environmentImpact": [
        {
          "amount": 12.5
        }
      ],
      "supplierName": "Green Energy Supplier",
      "energyProductName": "EcoPower 2025"
    },
    "pictures": [
      "https://example.com/picture1.jpg",
      "https://example.com/picture2.jpg"
    ],
    "siteDeveloper": {
      "name": "John Doe",
      "email": "john.doe@example.com",
      "companyRegistrationNumber": "12345678"
    },
    "cafeAddress": {
      "address1": "Strandboulevarden 122",
      "address2": "København",
      "address3": "5. sal",
      "zip": "2100",
      "city": "Copenhagen",
      "province": "Lombardy",
      "country": "Denmark",
      "countryAreaId": 1
    },
    "foodDeliveryAddress": {
      "address1": "Strandboulevarden 122",
      "address2": "København",
      "address3": "5. sal",
      "zip": "2100",
      "city": "Copenhagen",
      "province": "Lombardy",
      "country": "Denmark",
      "countryAreaId": 1
    },
    "hotelAddress": {
      "address1": "Strandboulevarden 122",
      "address2": "København",
      "address3": "5. sal",
      "zip": "2100",
      "city": "Copenhagen",
      "province": "Lombardy",
      "country": "Denmark",
      "countryAreaId": 1
    },
    "mallAddress": {
      "address1": "Strandboulevarden 122",
      "address2": "København",
      "address3": "5. sal",
      "zip": "2100",
      "city": "Copenhagen",
      "province": "Lombardy",
      "country": "Denmark",
      "countryAreaId": 1
    },
    "museumAddress": {
      "address1": "Strandboulevarden 122",
      "address2": "København",
      "address3": "5. sal",
      "zip": "2100",
      "city": "Copenhagen",
      "province": "Lombardy",
      "country": "Denmark",
      "countryAreaId": 1
    },
    "parkAddress": {
      "address1": "Strandboulevarden 122",
      "address2": "København",
      "address3": "5. sal",
      "zip": "2100",
      "city": "Copenhagen",
      "province": "Lombardy",
      "country": "Denmark",
      "countryAreaId": 1
    },
    "outdoorGymAddress": {
      "address1": "Strandboulevarden 122",
      "address2": "København",
      "address3": "5. sal",
      "zip": "2100",
      "city": "Copenhagen",
      "province": "Lombardy",
      "country": "Denmark",
      "countryAreaId": 1
    },
    "recreationAreaAddress": {
      "address1": "Strandboulevarden 122",
      "address2": "København",
      "address3": "5. sal",
      "zip": "2100",
      "city": "Copenhagen",
      "province": "Lombardy",
      "country": "Denmark",
      "countryAreaId": 1
    },
    "restaurantAddress": {
      "address1": "Strandboulevarden 122",
      "address2": "København",
      "address3": "5. sal",
      "zip": "2100",
      "city": "Copenhagen",
      "province": "Lombardy",
      "country": "Denmark",
      "countryAreaId": 1
    },
    "supermarketAddress": {
      "address1": "Strandboulevarden 122",
      "address2": "København",
      "address3": "5. sal",
      "zip": "2100",
      "city": "Copenhagen",
      "province": "Lombardy",
      "country": "Denmark",
      "countryAreaId": 1
    },
    "roofed": true,
    "lighting": true,
    "openingDate": "2023-01-01",
    "openingHours": {
      "openingTimes": {
        "regularHours": {
          "weekday": 1,
          "periodBegin": "08:00",
          "periodEnd": "17:00"
        },
        "exceptionalOpenings": {
          "periodBegin": "08:00",
          "periodEnd": "17:00"
        },
        "exceptionalClosings": {
          "periodBegin": "08:00",
          "periodEnd": "17:00"
        }
      },
      "chargingWhenClosed": true
    },
    "totalParkingSpaces": 100,
    "totalAccessibleSpace": 10,
    "trailerParking": true,
    "facilities": "Road",
    "venueWithAccessibility": true
  }
}

Changes

    • breaking

      the response's property type changed from array to object for status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the required property to the response with the status