Passer à la navigation
ReceptionLocations

Get Location

Get a single location by ID.

Paramètres de chemin

location_idstringRequis

En-têtes

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

Réponse

Réponse réussie

namestring
Internal name, e.g. 'Main Office' or 'Downtown Branch', shown in the dashboard and owner notifications.
_idstring
is_activebooleanLecture seule
addressstringOptionnel
Street address.
notesstringOptionnel
Directions or other notes for customers, e.g. 'Free parking behind the building'.
operating_hoursobjectOptionnel
customer_facing_namestringOptionnel

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerOptionnel1-999Par défaut 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 nullOptionnel
Unix timestamp when this location was deactivated. None when active.
deactivation_reasonenum or nullOptionnel
Why this location was deactivated. None when active.
Valeurs autorisées:

Erreurs

422
Unprocessable Entity Error