---
title: "Retrieve your (charge) sites"
method: GET
path: "/api/v1/sites"
tags: ["Sites"]
---

# Retrieve your (charge) sites

`GET /api/v1/sites`

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

## Query parameters

- `page` integer
- `perPage` integer
- `teamId` integer, nullable — Allows to filter by a team id.
- `partnerExternalId` string, nullable — Filter by partnerExternalId, to filter only resources without `partnerExternalId` *use* `partnerExternalId=""`
- `sortByLocation` string, 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)
- `operatorId` integer, 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.
- `includePublic` boolean — Includes public sites from other operators in the response</br>**Note: Only supported from Version `2024-07-01`**
- `includeDeleted` boolean — Includes deleted resources in the response

## Response `200`

List of sites that match the criteria

- OffsetBasedResponse27
  - `data` Site1[], required
    - `id` integer — Id of the site
    - `teamId` integer, nullable — Id of the team that has access to the site
    - `partnerExternalId` string, nullable — External Id of this entity, managed by you.
    - `partnerCustomPayload` object[], nullable — Custom JSON payload for this entity, managed by you.
    - `name` string, required — Name of the site
    - `operator` Operator
      - `id` integer — ID of the operator
      - `name` string, required — Name of operator
      - `identifier` string, required — Identifier of operator
      - `partnerId` integer, nullable — Id of the partner
      - `vatNumber` string, nullable — VAT number
    - `createdAt` string, date-time, required — Creation date of this charging site
    - `updatedAt` string, date-time, required — Date this charging site was last updated
    - `deletedAt` string, date-time, nullable — Date this charging site was deleted
    - `chargePointCount` integer — Number of charge points at this site
    - `activeChargePointCount` integer — Number of *active* charge points at this site
    - `availableChargePointCount` integer — Number of *available* charge points at this site
    - `maxKW` number, double, nullable — Deprecated (will be removed by 01.04.24), use `maxKw` field instead.
    - `maxKw` number, 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`.
    - `showOnMap` boolean, 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.
    - `note` string, nullable — A note you have entered for this site, e.g. via our Portal.
    - `location` Location, required
      - `coordinates` Coordinates
        - `latitude` number, double — Latitude value of coordinate
        - `longitude` number, double — Longitude value of coordinate
      - `addressLabel` string, nullable — The full address.
      - `address` PartialAddress
        - `address1` string, nullable — First line of address
        - `address2` string, nullable — Second line of address
        - `address3` string, nullable — Third line of address
        - `zip` string, nullable — Zip-code
        - `city` string, nullable — City (readable)
        - `province` string, nullable — Province
        - `country` string, nullable — Country (readable)
        - `countryAreaId` integer, nullable — Country area id
    - `connectors` ChargePointConnector[], required — List of supported connector types at this site (e.g. type-2, ccs, ...)
      - `id` integer — Id of this connector
      - `identifier` string, required — Identifier of connector
      - `name` string, required — Readable name of connector
    - `metadata` SiteMetadata
      - `atm` boolean, nullable — ATM available at the site
      - `digitalChargePriceDisplay` boolean, nullable — Digital charge price display available
      - `driverLounge` boolean, nullable — Driver lounge available
      - `fuelStation` boolean, nullable — Fuel station available
      - `parkingArea` boolean, nullable — Parking area available
      - `powerSupply` boolean, nullable — Power supply available
      - `shower` boolean, nullable — Shower available
      - `vendingMachine` boolean, nullable — Vending machine available
      - `washingMachine` boolean, nullable — Washing machine available
      - `wifi` boolean, nullable — WiFi available
      - `toilets` integer, nullable — Number of toilets
      - `cafe` boolean, nullable — Cafe available
      - `foodDelivery` boolean, nullable — Food delivery available
      - `hotel` boolean, nullable — Hotel available
      - `mall` boolean, nullable — Mall available
      - `museum` boolean, nullable — Museum available
      - `park` boolean, nullable — Park available
      - `outdoorGym` boolean, nullable — Outdoor gym available
      - `recreationArea` boolean, nullable — Recreation area available
      - `restaurant` boolean, nullable — Restaurant available
      - `supermarket` boolean, nullable — Supermarket available
      - `airport` boolean, nullable — Airport nearby
      - `bikeSharing` boolean, nullable — Bike sharing available
      - `busStop` boolean, nullable — Bus stop nearby
      - `carpoolParking` boolean, nullable — Carpool parking available
      - `metroStation` boolean, nullable — Metro station nearby
      - `taxiStand` boolean, nullable — Taxi stand available
      - `tramStop` boolean, nullable — Tram stop nearby
      - `secureTruckParking` boolean, nullable — Secure truck parking available
      - `truckDealership` boolean, nullable — Truck dealership available
      - `truckParking` boolean, nullable — Truck parking available
      - `truckRepair` boolean, nullable — Truck repair available
      - `truckWash` boolean, nullable — Truck wash available
      - `accessControlledArea` boolean, nullable — Access controlled area
      - `cameraSurveillance` boolean, nullable — Camera surveillance
      - `entryGate` boolean, nullable — Entry gate available
      - `exitGate` boolean, nullable — Exit gate available
      - `floodLighting` boolean, nullable — Flood lighting available
      - `guard` boolean, nullable — Guard available
      - `licensePlateRecognition` boolean, nullable — License plate recognition available
      - `pedestrianTurnstiles` boolean, nullable — Pedestrian turnstiles available
      - `perimeterFence` boolean, nullable — Perimeter fence available
      - `energyMix` EnergyMix
        - `isGreenEnergy` boolean, nullable — Indicates if the energy is green
        - `energySources` EnergySource[], nullable — List of energy sources with their category and percentage
          - `source` 'NUCLEAR' | 'GENERAL_FOSSIL' | 'COAL' | 'GAS' | 'GENERAL_GREEN' | 'SOLAR' | 'WIND' | 'WATER', required
          - `percentage` number, double — Percentage of this energy source
        - `environmentImpact` EnvironmentalImpact[], nullable — List of environmental impacts for this energy mix
          - `category` 'CO2' | 'NOX' | 'SO2' | 'PARTICULATE_MATTER' | 'WATER_USE' | 'LAND_USE' | 'OTHER', required
          - `amount` number, float — Amount of environmental impact
        - `supplierName` string, nullable — Name of the energy supplier
        - `energyProductName` string, nullable — Name of the energy product
      - `pictures` string[], nullable — Pictures of the site
      - `siteDeveloper` SiteDeveloper
        - `name` string, nullable — Name of the developer
        - `email` string, nullable — Email of the developer
        - `companyRegistrationNumber` string, nullable — Company registration number
      - `cafeAddress` Address
        - `address1` string, required — First line of address
        - `address2` string, nullable — Second line of address
        - `address3` string, nullable — Third line of address
        - `zip` string, required — Zip-code
        - `city` string, required — City (readable)
        - `province` string, nullable — Province
        - `country` string, nullable — Country (readable)
        - `countryAreaId` integer, nullable — Country area id
      - `foodDeliveryAddress` Address
        - `address1` string, required — First line of address
        - `address2` string, nullable — Second line of address
        - `address3` string, nullable — Third line of address
        - `zip` string, required — Zip-code
        - `city` string, required — City (readable)
        - `province` string, nullable — Province
        - `country` string, nullable — Country (readable)
        - `countryAreaId` integer, nullable — Country area id
      - `hotelAddress` Address
        - `address1` string, required — First line of address
        - `address2` string, nullable — Second line of address
        - `address3` string, nullable — Third line of address
        - `zip` string, required — Zip-code
        - `city` string, required — City (readable)
        - `province` string, nullable — Province
        - `country` string, nullable — Country (readable)
        - `countryAreaId` integer, nullable — Country area id
      - `mallAddress` Address
        - `address1` string, required — First line of address
        - `address2` string, nullable — Second line of address
        - `address3` string, nullable — Third line of address
        - `zip` string, required — Zip-code
        - `city` string, required — City (readable)
        - `province` string, nullable — Province
        - `country` string, nullable — Country (readable)
        - `countryAreaId` integer, nullable — Country area id
      - `museumAddress` Address
        - `address1` string, required — First line of address
        - `address2` string, nullable — Second line of address
        - `address3` string, nullable — Third line of address
        - `zip` string, required — Zip-code
        - `city` string, required — City (readable)
        - `province` string, nullable — Province
        - `country` string, nullable — Country (readable)
        - `countryAreaId` integer, nullable — Country area id
      - `parkAddress` Address
        - `address1` string, required — First line of address
        - `address2` string, nullable — Second line of address
        - `address3` string, nullable — Third line of address
        - `zip` string, required — Zip-code
        - `city` string, required — City (readable)
        - `province` string, nullable — Province
        - `country` string, nullable — Country (readable)
        - `countryAreaId` integer, nullable — Country area id
      - `outdoorGymAddress` Address
        - `address1` string, required — First line of address
        - `address2` string, nullable — Second line of address
        - `address3` string, nullable — Third line of address
        - `zip` string, required — Zip-code
        - `city` string, required — City (readable)
        - `province` string, nullable — Province
        - `country` string, nullable — Country (readable)
        - `countryAreaId` integer, nullable — Country area id
      - `recreationAreaAddress` Address
        - `address1` string, required — First line of address
        - `address2` string, nullable — Second line of address
        - `address3` string, nullable — Third line of address
        - `zip` string, required — Zip-code
        - `city` string, required — City (readable)
        - `province` string, nullable — Province
        - `country` string, nullable — Country (readable)
        - `countryAreaId` integer, nullable — Country area id
      - `restaurantAddress` Address
        - `address1` string, required — First line of address
        - `address2` string, nullable — Second line of address
        - `address3` string, nullable — Third line of address
        - `zip` string, required — Zip-code
        - `city` string, required — City (readable)
        - `province` string, nullable — Province
        - `country` string, nullable — Country (readable)
        - `countryAreaId` integer, nullable — Country area id
      - `supermarketAddress` Address
        - `address1` string, required — First line of address
        - `address2` string, nullable — Second line of address
        - `address3` string, nullable — Third line of address
        - `zip` string, required — Zip-code
        - `city` string, required — City (readable)
        - `province` string, nullable — Province
        - `country` string, nullable — Country (readable)
        - `countryAreaId` integer, nullable — Country area id
      - `parkingType` 'notDefined' | 'alongHighway' | 'onDriveway' | 'onStreet' | 'parkingGarage' | 'privateParkingArea' | 'publicParkingArea' | 'publicParkingGarage'
      - `roofed` boolean, nullable — Roofed area available
      - `lighting` boolean, nullable — Lighting available
      - `openingDate` string, nullable — Opening date of the site
      - `openingHours` OpeningHour
        - `openingTimes` Hours
          - `twentyFourSeven` boolean, nullable — Is the location open 24/7?
          - `regularHours` RegularHours
            - `weekday` integer — Number of day in the week, from Monday (1) till Sunday (7)
            - `periodBegin` string, required — Period begin in HH:mm format (e.g. 08:00)
            - `periodEnd` string, required — Period end in HH:mm format (e.g. 17:00 or 00:00 for end of day)
          - `exceptionalOpenings` ExceptionalPeriod
            - `periodBegin` string, required — Exceptional period begin in HH:mm format (e.g. 08:00)
            - `periodEnd` string, required — Exceptional period end in HH:mm format (e.g. 17:00 or 00:00 for end of day)
          - `exceptionalClosings` ExceptionalPeriod
            - `periodBegin` string, required — Exceptional period begin in HH:mm format (e.g. 08:00)
            - `periodEnd` string, required — Exceptional period end in HH:mm format (e.g. 17:00 or 00:00 for end of day)
        - `chargingWhenClosed` boolean, nullable — Indicates if charging is allowed when closed
      - `totalParkingSpaces` integer, nullable — Total number of parking spaces at the site
      - `totalAccessibleSpace` integer, nullable — Total number of accessible parking spaces at the site
      - `truckOnly` boolean, nullable — Total number of truck parking spaces at the site
      - `trailerParking` boolean, nullable — Indicates if trailer parking is available at the site
      - `facilities` string, nullable — Parking facilities available at the site
      - `venueWithAccessibility` boolean, nullable — Indicates if the site is accessible for people with disabilities
  - `meta` MontaPageMeta, required
    - `itemCount` integer, required
    - `currentPage` integer, required
    - `perPage` integer, required
    - `totalPageCount` integer, required
    - `totalItemCount` integer, required

## Other responses

- `400` — The request is invalid
- `401` — Consumer with provided credentials was not found
- `403` — Operator doesn't have access to resource
- `404` — Entity with the provided id was not found

---

[API](https://skmtc.net/monta/apis/monta-partner-api.md) · [All operations](https://skmtc.net/monta/apis/monta-partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/monta/monta-partner-api/versions/517e18f11015/schema)