Przejdź do nawigacji
ReceptionLocations

Get Location

Get a single location by ID.

Parametry ścieżki

location_idstringWymagany

Nagłówki

xi-api-keystringOpcjonalny
xi-workspace-idstring or nullOpcjonalny
The customer workspace a reseller's API key acts on.

Odpowiedź

Pomyślna odpowiedź

namestring
Internal name, e.g. 'Main Office' or 'Downtown Branch', shown in the dashboard and owner notifications.
_idstring
is_activebooleanTylko do odczytu
addressstringOpcjonalny
Street address.
notesstringOpcjonalny
Directions or other notes for customers, e.g. 'Free parking behind the building'.
operating_hoursobjectOpcjonalny
customer_facing_namestringOpcjonalny

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerOpcjonalny1-999Domyślnie 1

Maximum number of appointments that may overlap at this location at a single instant. Only enforced while the booking page setting concurrent_limit_enabled is on.

deactivated_at_unixinteger or nullOpcjonalny
Unix timestamp when this location was deactivated. None when active.
deactivation_reasonenum or nullOpcjonalny
Why this location was deactivated. None when active.
Dozwolone wartości:

Błędy

422
Unprocessable Entity Error