Skip to main content
GET
Retrieve one location. It has the same shape as an entry of List Locations. The url of a location.* webhook event points here. Requires the locations_view or test_sessions_schedule scope.

Request

Path parameters

string
required
Location ID (UUID).

Response

On success, the API returns 200 OK with the location object.
string
required
Unique location identifier (UUID).
string
required
Display name of the location.
string
Company or clinic name. May be null.
string
Street name, without the house number. May be null.
string
House number. May be null.
string
Additional address line — c/o, building, or floor. May be null.
string
City. May be null.
string
State or province. May be null when the city has no linked state (e.g. city-states or unmapped imports).
string
The state’s ISO 3166-2 code without the country prefix (e.g., BW for Baden-Württemberg). May be null.
string
Postal or ZIP code. May be null.
string
Full country name. May be null.
string
ISO 3166-1 alpha-2 country code (e.g., DE, US, FI). May be null.
string
IANA timezone identifier (e.g., Europe/Berlin). May be null.
number
Latitude of the address in decimal degrees (WGS 84). May be null.
number
Longitude of the address in decimal degrees (WGS 84). May be null.
string
Contact phone number for the location. May be null.
string
Contact email address. May be null.
string
Website URL. May be null.
string
Google Maps link for the location. May be null.
string
URL of a location photo. May be null.
object
Weekly opening hours. Each weekday key (monday–sunday) maps to an array of open/close time ranges. An empty array means the location is closed that day. The whole object is null when hours are not available for the location.

Error responses