Locations
List Locations
Retrieve all test locations available to your API key
GET
Retrieve all test locations accessible to your API key. Use the
id from a returned location when creating an appointment with Create Appointment.
Request
This endpoint takes no request parameters.Response
On success, the API returns200 OK with an array of location objects.
Unique location identifier (UUID).
Display name of the location.
Company or clinic name. May be
null.Street address line 1. May be
null.Street address line 2. May be
null.City. May be
null.State or province. May be
null when the city has no linked state (e.g. city-states or unmapped
imports).Postal or ZIP code. May be
null.Full country name. May be
null.ISO 3166-1 alpha-2 country code (e.g.,
DE, US, FI). May be null.IANA timezone identifier (e.g.,
Europe/Berlin). May be null.Contact phone number for the location. May be
null.Contact email address. May be
null.Website URL. May be
null.Google Maps link for the location. May be
null.URL of a location photo. May be
null.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
| Status | Description |
|---|---|
403 | Forbidden — your API key does not have access to this operation. |
500 | Internal server error. |