Skip to main content
GET
Locations / List

Authorizations

Authorization
string
header
required

OAuth2 Bearer Authorization

Scopes

asset:locations

Headers

Accept-Language
string

BCP 47 language tag for content negotiation (e.g. en, de-DE).

Example:

"en"

Query Parameters

contract_id
integer<int32>

Filters the result to locations attached to this non-commodity contract.

latitude
number<float>

Latitude coordinate for filtering nearby results within a 5 km radius. Must be used together with longitude.

longitude
number<float>

Longitude coordinate for filtering nearby results within a 5 km radius. Must be used together with latitude.

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 string length: 3 - 256
limit
integer<int64>

Maximum number of items per page. Maximum value is 25.

Required range: 1 <= x <= 25
Example:

"10"

page
integer<int64>

Page number to retrieve (starting from 1).

Required range: x >= 1
Example:

"1"

Response

Paginated list of locations.

locations
object[]
required

The locations in this page.

pagination
object

Pagination