Skip to main content

1. Create an API key

API keys are managed in the Backoffice by a global admin.
1

Open the Integrations page

Go to backoffice.vizito.be → Integrations and open the API keys section.
2

Create the key

Give it a name that says which integration it is for, tick the locations it may reach, and optionally set an expiry date and a list of IP addresses it may be used from.
3

Copy the key

The key is shown once. Store it in your secret manager right away — Vizito only keeps a hash of it and cannot show it again.
A key looks like vzk_1a2b3c4d5e6f7890_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx. Treat it like a password: it is a global admin on the locations you picked.
More detail — expiry, IP restrictions, Microsoft Entra ID — in Authentication.

2. Check that it works

Response
This is the one endpoint that needs no location id, and it tells you exactly which locations your key covers. Keep the _id — it is the company_id every other endpoint asks for.
Nothing came back? An empty array means the key is valid but attached to no location you can see. A 403 Invalid API key means the credential itself was refused — see Errors.

3. Read today’s visitors

Response
count and page are required on this endpoint. Pass count=25&page=1 if you just want the most recent page.

4. Sign someone in

The visit is created exactly as if it happened on a kiosk: the host is notified, the badge is printed if the visit type prints one, and the sign-in email goes out.

Where to go next

Core concepts

What a visit type is, and why almost everything hangs off a location.

Sign in a visitor

The full sign-in flow, custom fields included.

Pre-register visitors

Create the visit up front and send the invitation.

API reference

Every endpoint in detail.

Related topics

Introduction