Location
A location is one reception: an office, a plant, a site. In the API it is calledcompany_id and it is a 24-character id.
Your API key is pinned to a set of locations. GET /api/companiesList lists them, and any request naming a location outside that set is refused with 403.
Historically a location is called a “company” in the API paths and payloads. Read
company_id as “location id” everywhere.Visit type
A visit type is the flow a visitor goes through: which questions are asked, which agreements have to be signed, whether a badge is printed, who gets notified and what the confirmation email says. Every location has at least one and one of them is the default. If you sign a visitor in without naming a visit type, the location’s default is used. Visit types matter to you for one practical reason: the questions asked, and therefore the fields you may send, are defined per visit type. See Visit types.Visitor
A visitor is one visit — a single sign-in event, not a person. Signing the same person in twice creates two visitors. A visitor is signed in whensigned_in is set, and still inside as long as signed_out is absent.
On top of that, every custom field the visit type defines is stored on the visitor under its own
field_name.
Registered visitor
A registered visitor (knownvisitor in the API) is an expected visitor: someone you pre-register before they arrive. It carries the same personal details as a visitor, plus:
When they arrive and sign in, a visitor is created from them and the registered visitor stays as it was. That is the link
known_visitor_id records.
Host
A host (visitee in the API) is a person who can be visited: the list reception picks from, and the autocomplete a visitor types into on the kiosk.
Hosts come in two flavours:
- Managed hosts — created in the Backoffice or through
POST /api/visitees, edited one by one. - External hosts — pushed in bulk from your directory with
POST /api/visitees/external/upload/{company_id}. They are replaced as a set on every push and are deliberately kept out of the regular host list endpoint.