> ## Documentation Index > Fetch the complete documentation index at: https://chargecloud.dev/llms.txt > Use this file to discover all available pages before exploring further. # Locations / List > Lists the locations visible to the authenticated client. Optionally filter by contract_id. Required permission: asset:locations:list. Available contexts: API Key, User. ## OpenAPI ````yaml /api/core-api/crmiapi.json get /api/v1/assets/locations openapi: 3.2.0 info: title: chargecloud - Core API summary: chargecloud Core API. All around CRM, Asset Management and more. version: 1.141.0 description: chargecloud Core API. All around CRM, Asset Management and more. servers: - url: https://api.chargecloud.dev description: Production - chargecloud Core API - url: https://demo.chargecloud.de description: Sandbox/Dev - chargecloud Core API security: [] paths: /api/v1/assets/locations: get: tags: - Locations summary: Locations / List description: >- Lists the locations visible to the authenticated client. Optionally filter by contract_id. Required permission: asset:locations:list. Available contexts: API Key, User. operationId: /api/v1/assets/locations_GET parameters: - name: contract_id in: query description: >- Filters the result to locations attached to this non-commodity contract. required: false schema: type: integer format: int32 description: >- Filters the result to locations attached to this non-commodity contract. - name: latitude in: query description: >- Latitude coordinate for filtering nearby results within a 5 km radius. Must be used together with longitude. required: false schema: type: number format: float description: >- Latitude coordinate for filtering nearby results within a 5 km radius. Must be used together with longitude. - name: longitude in: query description: >- Longitude coordinate for filtering nearby results within a 5 km radius. Must be used together with latitude. required: false schema: type: number format: float description: >- Longitude coordinate for filtering nearby results within a 5 km radius. Must be used together with latitude. - name: search in: query description: >- Free-text search across location name, identifier, street, house number and city, the name (the OCPP ChargeBox-ID) and serial number of its controllers and any part of the EVSE-ID of its charge points. EVSE-ID separators and case are ignored; the EVSE-ID part needs at least 3 letters or digits. required: false schema: type: string minLength: 3 maxLength: 256 description: >- Free-text search across location name, identifier, street, house number and city, the name (the OCPP ChargeBox-ID) and serial number of its controllers and any part of the EVSE-ID of its charge points. EVSE-ID separators and case are ignored; the EVSE-ID part needs at least 3 letters or digits. - name: limit in: query description: Maximum number of items per page. Maximum value is 25. required: false schema: type: integer format: int64 minimum: 1 maximum: 25 description: Maximum number of items per page. Maximum value is 25. example: '10' - name: page in: query description: Page number to retrieve (starting from 1). required: false schema: type: integer format: int64 minimum: 1 description: Page number to retrieve (starting from 1). example: '1' - name: Accept-Language in: header description: BCP 47 language tag for content negotiation (e.g. en, de-DE). required: false schema: type: string description: BCP 47 language tag for content negotiation (e.g. en, de-DE). example: en responses: '200': headers: Content-Language: description: The locale of the response content (BCP 47 language tag). required: false schema: type: string example: en content: application/json: schema: type: object required: - locations properties: locations: type: array items: type: object properties: uuid: type: string pattern: >- ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$ description: >- The unique identifier of the location, automatically assigned by the system upon creation. Use this UUID to retrieve, update, or reference the location in subsequent API calls. created_at: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Date the location was created. updated_at: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Date of the last user-driven update. modification_date: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: >- Timestamp refreshed on every persisted change to the row. controllers: type: array items: type: object properties: controller_uuid: type: string description: >- UUID of a controller installed at the location. required: - controller_uuid description: >- UUIDs of the charging point controllers installed at this location, i.e. the hardware devices managing its charging points. charge_point_count: type: integer format: int32 minimum: 0 description: >- The number of charge points at this location, counted across all its controllers. publish: type: boolean default: true description: >- Whether the location is publicly visible via interfaces and map services. When false, the location and all its charging points are hidden from public-facing outputs. name: type: string maxLength: 100 description: >- Human-readable name of the location, displayed in the app and backend. Must be unique across all locations. identifier: type: string maxLength: 5 pattern: ^[A-z0-9]{0,5}$ description: >- Short alphanumeric code the operator uses internally. example: BUS02 status: type: string enum: - in_questioning - in_offer - first_meeting - in_planning - under_construction - active - out_of_order - no_activity - discarded - undefined description: >- Lifecycle state. Allowed values: in_questioning (sales inquiry), first_meeting (initial customer meeting), in_offer (offer phase), in_planning (planning), under_construction (build in progress), active (live), out_of_order (offline), no_activity (idle), discarded (dropped), undefined. street: type: string maxLength: 100 description: >- Street name of the location address. Used for geolocation and display on map services. house_number: type: string maxLength: 10 description: >- House number of the location address, kept separate from `street`; may contain letters or suffixes (e.g., "12a"). postal_code: type: string maxLength: 16 description: Postal / ZIP code. city: type: string maxLength: 100 description: City of the location address. district: type: string maxLength: 100 description: City district / neighbourhood. rural_district: type: string maxLength: 100 description: Administrative rural district (Landkreis). country_code: type: string enum: - ABW - AFG - AGO - AIA - ALA - ALB - AND - ARE - ARG - ARM - ASM - ATA - ATF - ATG - AUS - AUT - AZE - BDI - BEL - BEN - BES - BFA - BGD - BGR - BHR - BHS - BIH - BLM - BLR - BLZ - BMU - BOL - BRA - BRB - BRN - BTN - BVT - BWA - CAF - CAN - CCK - CHE - CHL - CHN - CIV - CMR - COD - COG - COK - COL - COM - CPV - CRI - CUB - CUW - CXR - CYM - CYP - CZE - DEU - DJI - DMA - DNK - DOM - DZA - ECU - EGY - ERI - ESH - ESP - EST - ETH - FIN - FJI - FLK - FRA - FRO - FSM - GAB - GBR - GEO - GGY - GHA - GIB - GIN - GLP - GMB - GNB - GNQ - GRC - GRD - GRL - GTM - GUF - GUM - GUY - HKG - HMD - HND - HRV - HTI - HUN - IDN - IMN - IND - IOT - IRL - IRN - IRQ - ISL - ISR - ITA - JAM - JEY - JOR - JPN - KAZ - KEN - KGZ - KHM - KIR - KNA - KOR - KWT - LAO - LBN - LBR - LBY - LCA - LIE - LKA - LSO - LTU - LUX - LVA - MAC - MAF - MAR - MCO - MDA - MDG - MDV - MEX - MHL - MKD - MLI - MLT - MMR - MNE - MNG - MNP - MOZ - MRT - MSR - MTQ - MUS - MWI - MYS - MYT - NAM - NCL - NER - NFK - NGA - NIC - NIU - NLD - NOR - NPL - NRU - NZL - OMN - PAK - PAN - PCN - PER - PHL - PLW - PNG - POL - PRI - PRK - PRT - PRY - PSE - PYF - QAT - REU - ROU - RUS - RWA - SAU - SDN - SEN - SGP - SGS - SHN - SJM - SLB - SLE - SLV - SMR - SOM - SPM - SRB - SSD - STP - SUR - SVK - SVN - SWE - SWZ - SXM - SYC - SYR - TCA - TCD - TGO - THA - TJK - TKL - TKM - TLS - TON - TTO - TUN - TUR - TUV - TWN - TZA - UGA - UKR - UMI - URY - USA - UZB - VAT - VCT - VEN - VGB - VIR - VNM - VUT - WLF - WSM - XKX - YEM - ZAF - ZMB - ZWE description: >- ISO 3166-1 alpha-3 country code (e.g. DEU, AUT, NLD). example: DEU latitude: type: number format: float description: WGS84 latitude in decimal degrees. example: '50.946022' longitude: type: number format: float description: WGS84 longitude in decimal degrees. example: '6.942467' height: type: number format: float minimum: 0 description: Elevation above sea level in metres. example: '100.00' directions: type: string maxLength: 500 description: >- Free-text driving / walking directions shown to drivers. description: type: string maxLength: 500 description: >- Internal free-text description of the location for backend users. Not displayed publicly. website: type: string maxLength: 200 description: Public website of the operator or the site. example: https://www.google.com comment: type: string maxLength: 500 description: >- Public-facing comment about the location, visible in the Whitelabel app and via POI web services. Use it for information end users should see (e.g. access restrictions, parking notes). operator: type: string maxLength: 100 description: Display name of the charging point operator (CPO). example: chargecloud GmbH partner: type: string maxLength: 255 description: >- Links the location to a non-commodity partner agreement. When set, the location partner can view this location in the partner app and may receive revenue-share credits. accounter: type: string maxLength: 64 description: >- Name of the accounting party associated with this location. Used for financial allocation and reporting. support_hotline: type: string maxLength: 25 pattern: ^\+[0-9]{6,20}$ description: >- The phone number of the support or fault hotline for this location, in international format (leading "+", digits only). Published in the Whitelabel app and transmitted to roaming partners. example: '+491234567890' comment_usage_agreement: type: string maxLength: 500 description: >- Free-text note about the usage agreement (Nutzungsvereinbarung). level_measurement: type: string maxLength: 200 description: >- Description of the on-site grid level measurement / metering setup. network_carrier: type: string maxLength: 255 description: >- Local distribution network operator (DNO / Netzbetreiber). available_power: type: string maxLength: 100 description: Grid power available on site (e.g. "63 A, 400 V"). additional_conditions: type: string maxLength: 500 description: Additional contractual or operational conditions. max_standing_time: type: string maxLength: 255 description: >- Informational free-text describing the maximum allowed standing time at the location (e.g., "max. 4h between 8 a.m. and 6 p.m."). For driver/operator information only — not enforced by the system. contract_id: type: integer format: int32 minimum: 0 description: >- Identifies the non-commodity contract this location belongs to, used for automated revenue sharing. Must be owned by the same client. facility_types: type: array items: type: object properties: uuid: type: string maxLength: 36 description: Stable UUID of the facility type. name: type: string maxLength: 30 description: >- Display name of the facility type (e.g. "parking garage", "public street"). required: - uuid - name description: FacilityType description: >- Facility types describing the surroundings of the location (e.g. "Hotel", "Restaurant", "Parking"). Transmitted to national access points for public charging points as required by AFIR regulation. required: - uuid - created_at - updated_at - modification_date - controllers - charge_point_count - name - status - street - postal_code - city - country_code - latitude - longitude - operator - support_hotline description: >- The location record with its address, coordinates, operator data and controllers. description: The locations in this page. pagination: type: object properties: page: type: integer format: int64 description: Current page number (starting from 1). example: '1' total_pages: type: integer format: int64 description: Total number of available pages. example: '5' page_size: type: integer format: int64 description: Number of items returned per page. example: '10' has_more: type: boolean default: true description: >- Indicates whether more pages are available after the current page. example: 'true' description: Pagination description: Paginated list of locations. '401': headers: Content-Language: description: The locale of the response content (BCP 47 language tag). required: false schema: type: string example: en content: application/json: schema: type: object required: - error properties: error: type: string description: Error message description: Unauthorized '403': headers: Content-Language: description: The locale of the response content (BCP 47 language tag). required: false schema: type: string example: en content: application/json: schema: type: object required: - error properties: error: type: string description: Error message description: Forbidden '404': headers: Content-Language: description: The locale of the response content (BCP 47 language tag). required: false schema: type: string example: en content: application/json: schema: type: object required: - error properties: error: type: string description: Error message description: Not found '405': headers: Content-Language: description: The locale of the response content (BCP 47 language tag). required: false schema: type: string example: en content: application/json: schema: type: object required: - error properties: error: type: string description: Error message description: Method not allowed '422': headers: Content-Language: description: The locale of the response content (BCP 47 language tag). required: false schema: type: string example: en content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: errorKey: type: string description: A key identifying the error message: type: string description: The error message parameter: type: string description: The parameter that caused the error, if any required: - errorKey - message - parameter description: Error description: List of errors description: Request validation failed security: - bearer: - asset:locations components: securitySchemes: bearer: type: http description: OAuth2 Bearer Authorization scheme: bearer bearerFormat: JWT ```` ## Related topics - [How To](https://chargecloud.dev/api/core-api/how-to.md) - [Introduction](https://chargecloud.dev/api/core-api/index.md) - [Controllers / List](https://chargecloud.dev/api-reference/controllers/controllers-list.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.