v1
latestOpenAPI 3.0.12026-07-243686491.1 MBSites
Retrieve your (charge) sites
Required scope: charge-points:read </br>Organization authorization: supported
get/api/v1/sites
Query parameters
pageinteger
page number to retrieve (starts with 0)
perPageinteger
number of items per page (between 1 and 100, default 10)
teamIdinteger nullable
Allows to filter by a team id.
Example:19
partnerExternalIdstring nullable
Filter by partnerExternalId, to filter only resources without partnerExternalId use partnerExternalId=""
Example:1
sortByLocationstring nullable
lat,long coordinates. If supplied, the Charge Points will be sorted in nearest first order relativeto this point. (Format: 55.7096,12.5856, -8.050000, -34.900002)
Example:55.7096,12.5856
operatorIdinteger nullable
Allows to filter sites by operatorId.</br>*Note:*The operatorId must be in the consumer’s operatorIds or, if empty, belong to the organization’s sub-operators.
Example:1
includePublicboolean
Includes public sites from other operators in the response</br>Note: Only supported from Version 2024-07-01
includeDeletedboolean
Includes deleted resources in the response
Example:true
Response
List of sites that match the criteria
Example response
{
"data": [
{
"id": 1,
"teamId": 13,
"partnerExternalId": "ACME-12345",
"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,
"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",
"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
}
}
]
}