Vai alla navigazione
ReceptionLocations

List Locations

List all business locations.

Header

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

Risposta

Risposta riuscita
namestring
Internal name, e.g. 'Main Office' or 'Downtown Branch', shown in the dashboard and owner notifications.
_idstring
is_activebooleanSola lettura
addressstringOpzionale
Street address.
notesstringOpzionale
Directions or other notes for customers, e.g. 'Free parking behind the building'.
operating_hoursobjectOpzionale
customer_facing_namestringOpzionale

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerOpzionale1-999Predefinito a 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 nullOpzionale
Unix timestamp when this location was deactivated. None when active.
deactivation_reasonenum or nullOpzionale
Why this location was deactivated. None when active.
Valori consentiti:

Errori

422
Unprocessable Entity Error