List Locations

---

GET services/api/v1/locations

Returns a list of locations.

Response

200

Results list.

Example

{
  "entries": [
    {
      "id": "1",
      "ancestor_id": null,
      "depth": 0,
      "subtree_ids": ["1"],
      "has_public_name": false,
      "ancestor_ids": [],
      "name_en": "Lana",
      "name_de": "Lana",
      ...
    },
    {
      "id": "2",
      "ancestor_id": null,
      "depth": 0,
      "subtree_ids": ["2", "3", "4"],
      "has_public_name": false,
      "ancestor_ids": [],
      "name_en": "Bolzano",
      "name_de": "Bolzano",
      ...
    },
    {
      "id": "3",
      "ancestor_id": "2",
      "depth": 1,
      "subtree_ids": ["3"],
      "has_public_name": false,
      "ancestor_ids": ["2"],
      "name_en": "Bolzano North",
      "name_de": "Bolzano North",
      ...
    },
    {
      "id": "4",
      "ancestor_id": "2",
      "depth": 1,
      "subtree_ids": ["4"],
      "has_public_name": false,
      "ancestor_ids": ["2"],
      "name_en": "Bolzano South",
      "name_de": "Bolzano South",
      ...
    }
  ],
  "current_page": 1,
  "per_page": 30,
  "total_entries": 4
}

Schema

Attribute	Type	Description
id	string	Encoded location id.
depth	int	Location tree depth of the current node.
ancestor_id	string	Location tree ancestor.
subtree_ids	string[]	Location subtree nodes.
ancestor_ids	string[]	Location ancestors.
has_public_name	boolean	Determines if the public name on, for example, career pages should be different than the internal name of the location.
name_{locale}	string	Location name in all locales of the business.
public_name_{locale}	string	Location public name in all locales of the business.
country	string	Location country.
region_{locale}	string	Location region in all locales of the business.
city_{locale}	string	Location City in all locales of the business.
postal_code	string	Location postal code.
street_{locale}	string	Location street adress in all locales of the business.
is_sub_business	boolean	Determines if the business is a sub-business or just a location of the main business.
sub_business_title_{locale}	string	Location sub business name in all locales of the business.