Get company locations

get/v1/public/locations

Request

Base URL
https://api.evolia.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/evolia/apis/public-evolia/docs/v1/public/locations/get.ts
A function with typed inputs. Its response is checked against the schema.

withDeletedboolean

if true, deleted locations are also returned

includeSubLocationsboolean

if true, sub locations detail is also returned

uidstring required

unique location id

status'deleted' | 'active' required

Location status

namestring required

Location name

abbrevstring

Location abbreviation

codestring

The location code. The code is often used as a mapping value between Evolia and an external system

externalIdstring

The unique location externalId. The externalId is often used as a mapping value between Evolia and an external system

addressstring

Location address

coordinatesstring[]

0: Longitude, 1: Latitude

subLocationIdsstring[]

Array of sub location UIDs linked to the location

subLocationsstring[]

Array of sub locations

customobject nullable

An optional object of custom properties. Current implementation only support string values

[
  {
    "custom": {
      "key1": "value1",
      "key2": "value2"
    }
  }
]

No recorded changes to this operation across all 8 revisions of this API.