Sites
Retrieve your (charge) sites
Required scope: charge-points:read
Organization authorization: supported
query Parameters
pagepage number to retrieve (starts with 0)
perPagenumber of items per page (between 1 and 100, default 10)
teamIdAllows to filter by a team id.
partnerExternalIdFilter by partnerExternalId, to filter only resources without partnerExternalId use partnerExternalId=""
sortByLocation^(-?\d*\.\d+|\d+\.\d…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)
operatorIdAllows to filter sites by operatorId.
*Note:*The operatorId must be in the consumer’s operatorIds or, if empty, belong to the organization’s sub-operators.
includePublicIncludes public sites from other operators in the response
Note: Only supported from Version 2024-07-01
includeDeletedIncludes deleted resources in the response
Retrieve your (charge) sites › Responses
List of sites that match the criteria
Create a (charge) site
Required scope: charge-points:write
Organization authorization: supported
Create a (charge) site › Request Body
teamIdId of the team that the site belongs to
nameName of the site
Address of the site. countryId is always required. address1, city, and zipCode must either all be provided (geocoding will resolve coordinates) or all be left null — in which case latitude and longitude must be supplied instead. Partial addresses are rejected.
visibilityVisibility type of the site. Controls who can charge at the site: public means any Monta user can charge here, private restricts charging to team members / access-token holders. This field does NOT control whether the site appears on the consumer map — use showOnMap for that.
latitudeLatitude coordinate for the site location. Required when the address (address1/city/zipCode) is omitted. When provided along with longitude, overrides geocoding from address.
longitudeLongitude coordinate for the site location. Required when the address (address1/city/zipCode) is omitted. When provided along with latitude, overrides geocoding from address.
showOnMapWhether this site should be visible on the consumer map. If omitted, the site will be visible on the map by default. This is independent of visibility — a private site can still be shown on the map, and a public site can be hidden.
driverSupportVisibilityWhether Monta's AI Driver Support may reach drivers at this site. Defaults to inherit when omitted.
- inherit — follow the site's visibility: a public site is reachable, a private site is not.
- public — always reachable, even when the site's visibility is private.
- off — never reachable, even when the site is public.
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
Metadata for the site including amenities, energy mix, opening hours, site developer, and pictures.
noteA free-text note for this site, visible in the app.
operatorIdDeprecated: the site is always assigned to the operator of its team.
Note: if provided, it must match the operator of the given team.
Create a (charge) site › Responses
Site created
nameName of the site
createdAtCreation date of this charging site
updatedAtDate this charging site was last updated
visibilityIndicates if this site is public or private. Controls who can charge at the site; independent of showOnMap.
driverSupportVisibilityWhether Monta's AI Driver Support may reach drivers at this site.
- inherit — follow the site's visibility: a public site is reachable, a private site is not.
- public — always reachable, even when the site's visibility is private.
- off — never reachable, even when the site is public.
Location information for this site
List of supported connector types at this site (e.g. type-2, ccs, ...)
idId of the site
teamIdId of the team that has access to the site
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys.
Operator of this charging site
deletedAtDate this charging site was deleted
chargePointCountNumber of charge points at this site
activeChargePointCountNumber of active charge points at this site
availableChargePointCountNumber of available charge points at this site
maxKwMax KW available at this site.
typeType of charge points at this site (AC / DC)
showOnMapWhether 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.
noteA note you have entered for this site, e.g. via our Portal.
Additional information for this site, e.g. totalParkingSpaces.
maxKWDeprecated (will be removed by 01.04.24), use maxKw field instead.
Retrieve a single (charge) site
Required scope: charge-points:read
Organization authorization: supported
path Parameters
siteIdRetrieve a single (charge) site › Responses
Site with provided id
nameName of the site
createdAtCreation date of this charging site
updatedAtDate this charging site was last updated
visibilityIndicates if this site is public or private. Controls who can charge at the site; independent of showOnMap.
driverSupportVisibilityWhether Monta's AI Driver Support may reach drivers at this site.
- inherit — follow the site's visibility: a public site is reachable, a private site is not.
- public — always reachable, even when the site's visibility is private.
- off — never reachable, even when the site is public.
Location information for this site
List of supported connector types at this site (e.g. type-2, ccs, ...)
idId of the site
teamIdId of the team that has access to the site
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys.
Operator of this charging site
deletedAtDate this charging site was deleted
chargePointCountNumber of charge points at this site
activeChargePointCountNumber of active charge points at this site
availableChargePointCountNumber of available charge points at this site
maxKwMax KW available at this site.
typeType of charge points at this site (AC / DC)
showOnMapWhether 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.
noteA note you have entered for this site, e.g. via our Portal.
Additional information for this site, e.g. totalParkingSpaces.
maxKWDeprecated (will be removed by 01.04.24), use maxKw field instead.
Patch an existing (charge) site
Required scope: charge-points:write
Organization authorization: supported
path Parameters
siteIdPatch an existing (charge) site › Request Body
nameName of the site
Address of the site. Only countryId is mandatory. Address1, city, and zipCode must be provided together or all left null.
latitudeLatitude coordinate for the site location. When provided along with longitude, overrides geocoding from address.
longitudeLongitude coordinate for the site location. When provided along with latitude, overrides geocoding from address.
visibilityVisibility type of the site. Controls who can charge at the site: public means any Monta user can charge here, private restricts charging to team members / access-token holders. This field does NOT control whether the site appears on the consumer map — use showOnMap for that.
showOnMapWhether this site should be visible on the consumer map. This is independent of visibility — a private site can still be shown on the map, and a public site can be hidden.
driverSupportVisibilityWhether Monta's AI Driver Support may reach drivers at this site. Omit to leave the current value untouched.
- inherit — follow the site's visibility: a public site is reachable, a private site is not.
- public — always reachable, even when the site's visibility is private.
- off — never reachable, even when the site is public.
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
Metadata for the site including amenities, energy mix, opening hours, site developer, and pictures.
noteA free-text note for this site, visible in the app.
Patch an existing (charge) site › Responses
Site updated
nameName of the site
createdAtCreation date of this charging site
updatedAtDate this charging site was last updated
visibilityIndicates if this site is public or private. Controls who can charge at the site; independent of showOnMap.
driverSupportVisibilityWhether Monta's AI Driver Support may reach drivers at this site.
- inherit — follow the site's visibility: a public site is reachable, a private site is not.
- public — always reachable, even when the site's visibility is private.
- off — never reachable, even when the site is public.
Location information for this site
List of supported connector types at this site (e.g. type-2, ccs, ...)
idId of the site
teamIdId of the team that has access to the site
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys.
Operator of this charging site
deletedAtDate this charging site was deleted
chargePointCountNumber of charge points at this site
activeChargePointCountNumber of active charge points at this site
availableChargePointCountNumber of available charge points at this site
maxKwMax KW available at this site.
typeType of charge points at this site (AC / DC)
showOnMapWhether 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.
noteA note you have entered for this site, e.g. via our Portal.
Additional information for this site, e.g. totalParkingSpaces.
maxKWDeprecated (will be removed by 01.04.24), use maxKw field instead.
Retrieve the amenities of a (charge) site
Required scope: charge-points:read
Organization authorization: supported
path Parameters
siteIdRetrieve the amenities of a (charge) site › Responses
Amenities of the site with the provided id
List of amenities configured for the site
Replace the amenities of a (charge) site
Replaces the full set of amenities on the site.
Required scope: charge-points:write
Organization authorization: supported
path Parameters
siteIdReplace the amenities of a (charge) site › Request Body
Full list of amenities to set on the site. Replaces any existing amenities.
Replace the amenities of a (charge) site › Responses
Amenities updated
List of amenities configured for the site
Retrieve the developer details of a (charge) site
Required scope: charge-points:read
Organization authorization: supported
path Parameters
siteIdRetrieve the developer details of a (charge) site › Responses
Developer details for the site with the provided id
nameName of the developer
emailEmail of the developer
companyRegistrationNumberCompany registration number
Update the developer details of a (charge) site
Required scope: charge-points:write
Organization authorization: supported
path Parameters
siteIdUpdate the developer details of a (charge) site › Request Body
nameDeveloper name
emailDeveloper email
companyRegistrationNumberCompany registration number
Update the developer details of a (charge) site › Responses
Updated developer details for the site
nameName of the developer
emailEmail of the developer
companyRegistrationNumberCompany registration number
Retrieve the energy mix of a (charge) site
Required scope: charge-points:read
Organization authorization: supported
path Parameters
siteIdRetrieve the energy mix of a (charge) site › Responses
Energy mix of the site with the provided id
List of energy sources with their category and percentage
List of environmental impacts for this energy mix
is_green_energyIndicates if the energy is green
supplier_nameName of the energy supplier
energy_product_nameName of the energy product
Update the energy mix of a (charge) site
Required scope: charge-points:write
Organization authorization: supported
path Parameters
siteIdUpdate the energy mix of a (charge) site › Request Body
isGreenEnergyWhether the site's electricity comes from renewable sources. true is a claim that has to be backed up in the same energy mix by at least one of: supplier_name, energy_product_name, or energy_sources with percentages adding up to 100. Blank names and partial source lists don't count, and the request is rejected with a 422. false or null needs no other fields.
List of energy sources with their category and percentage
List of environmental impacts for this energy mix
supplierNameName of the energy supplier
energyProductNameName of the energy product
Update the energy mix of a (charge) site › Responses
Energy mix updated
List of energy sources with their category and percentage
List of environmental impacts for this energy mix
is_green_energyIndicates if the energy is green
supplier_nameName of the energy supplier
energy_product_nameName of the energy product
Retrieve the images of a (charge) site
Required scope: charge-points:read
Organization authorization: supported
path Parameters
siteIdRetrieve the images of a (charge) site › Responses
Images of the site
imagesPublic URLs of the images attached to this site (max 4)
Upload an image to a (charge) site
Uploads a jpeg/png image (max 2MB, max 4 per site) and returns the updated list of image URLs. Required scope: charge-points:write
Organization authorization: supported
path Parameters
siteIdUpload an image to a (charge) site › Responses
Image uploaded, updated list of image URLs returned
imagesPublic URLs of the images attached to this site (max 4)
Delete an image from a (charge) site
Removes the image with the provided public url and returns the remaining image URLs. Required scope: charge-points:delete
Organization authorization: supported
path Parameters
siteIdquery Parameters
urlDelete an image from a (charge) site › Responses
Image deleted, remaining list of image URLs returned
imagesPublic URLs of the images attached to this site (max 4)
Update the opening hours of a (charge) site
Required scope: charge-points:write
Organization authorization: supported
path Parameters
siteIdUpdate the opening hours of a (charge) site › Request Body
Opening times for the location
chargingWhenClosedIndicates if charging is allowed when closed
Update the opening hours of a (charge) site › Responses
Opening hours updated
Opening times for the location
chargingWhenClosedIndicates if charging is allowed when closed