Show Location

---

GET /services/api/v1/locations/{id}

Returns the requested location.

Parameters

Parameter	Type	Description
id	string	The ID of the location.

Response

200

Requested location.

Example

{
  "id": "A96ey16n",
  "postal_code": null,
  "country": null,
  "ancestor_id": null,
  "depth": 0,
  "subtree_ids": ["A96ey16n"],
  "is_sub_business": false,
  "has_public_name": false,
  "display_name": "",
  "name_de": "München",
  "name_it": "Monaco",
  "street_de": null,
  "street_it": null,
  "city_de": "Garching",
  "city_it": "Garching",
  "region_de": null,
  "region_it": null,
  "public_name_de": "München",
  "public_name_it": "Monaco",
  "ancestor_ids": []
}

Schema

Attribute	Type	Description
id	string	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 address 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.