Naar navigatie springen
ReceptionLocations

Get Location

Get a single location by ID.

Padparameters

location_idstringVerplicht

Headers

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

Response

Geslaagde response
namestring
Internal name, e.g. 'Main Office' or 'Downtown Branch', shown in the dashboard and owner notifications.
_idstring
is_activebooleanAlleen-lezen
addressstringOptioneel
Street address.
notesstringOptioneel
Directions or other notes for customers, e.g. 'Free parking behind the building'.
operating_hoursobjectOptioneel
customer_facing_namestringOptioneel

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerOptioneel1-999Standaard 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 nullOptioneel
Unix timestamp when this location was deactivated. None when active.
deactivation_reasonenum or nullOptioneel
Why this location was deactivated. None when active.
Toegestane waarden:

Fouten

422
Unprocessable Entity Error