Skip to main content
Every managed host at a location, sorted by name. A host is somebody a visitor can come to see — the list reception picks from and the kiosk autocompletes against.

​
Path parameters

​
string
required
The location.

​
Response

A plain array of hosts.
​
string
The host id.
​
string
Full name. This is the join key: a visit’s recipient matches a host on it.
​
string
Email address, stored lower-cased. Where sign-in notifications go.
​
string
Mobile number, used for SMS notifications.
​
string
Desk phone, shown to reception.
​
boolean
Pinned to the top of the kiosk list.
​
string
When the host was added.
​
string
When it last changed.
Hosts pushed through Replacing the host list carry external: true and are deliberately not in this list. There is no endpoint that reads the external list back — keep your own copy of what you pushed.

​
Paged variant

Same list with count, page, sorting[field] and filter[field], answering { "total": ..., "visitees": [...] }.

Related topics

Replacing the host listDeleting a hostFetching a hostUpdating a hostCreating a host