Locations / Listing

get https://{tenantUrl}/public-api/resources/locations/v2.0

Get all locations

Responses

Response body

object

data

array of objects

data

object

integer

name

array of objects

required

name*

object

locale

string

valid locale

translation

string

status

string

required

deprecated

enabled disabled

shortDescription

array of objects

shortDescription

object

locale

string

valid locale

translation

string

description

array of objects

description

object

locale

string

valid locale

translation

string

additionalDescription

array of objects

additionalDescription

object

locale

string

valid locale

translation

string

locationImage

object | null

If include[]=locationImage is provided with the request, the locationImageId will be replaced with the locationImage object if a location image has been assigned to the Location

images

array of objects

If include[]=images is provided with the request, this array will contain the properties of all images assigned to the location.

images

object

original

string

required

URL to the original image

thumbnail

string

URL to a thumbnail image

mimeType

string

required

geoposition

object

required

address

array of objects

required

address*

object

locale

string

valid locale

translation

string

city

string | null

required

region

string | null

When country is not US or AU, you can provide the region

state

When the selected country is US or AU

country

string

required

AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BQ BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CW CY CZ DK DJ DM DO EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM VA HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KP KR XK KW KG LA LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW BL SH KN LC MF PM VC WS SM ST SA SN RS SC SL SG SX SK SI SB SO ZA GS SS ES LK SD SR SJ SZ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VE VN VG VI WF EH YE ZM ZW

postCode

string | null

workingHours

object

timezone

string | null

A valid timezone in the form of Area/Location, required when Allow Multiple Time Zones option is turned on in the Timezone Setting.

externalId

string | null

lastUpdatedAt

date-time

ISO 8601 formatted date

chargingZones

array of objects

If include[]=chargingZones is provided with the request, the location charging zones will be provided here.

chargingZones

object

integer

name

string

Internal name of the Charging Zone. This isn't visible to end-users in the app.

locationId

integer

The ID of the Location, which the Charging Zone belongs to.

status

string

enabled disabled

additionalInfo

object

Additional information for the charging zone that is shown in the mobile app when the Location is viewed.

externalAppData

object | null

Used to hold any external application data related to the Location.

Has additional fields

links

object

first

string | null

The URL to fetch the first page

last

string | null

The URL to fetch the last page

string | null

The URL to fetch the previous page

string | null

The URL to fetch the next page. Use this link always in order to utilize the cursor pagination

200Success

401Access token is missing or invalid

403You do not have permission to perform the action

404The record is not found