curl --request GET \
--url https://api.vizito.eu/api/visitors/{visitor_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vizito.eu/api/visitors/{visitor_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vizito.eu/api/visitors/{visitor_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vizito.eu/api/visitors/{visitor_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"_id": "5f2a1b9c4d3e2f0011223344",
"company_id": "5f2a1b9c4d3e2f0011223344",
"first_name": "Ada",
"last_name": "Lovelace",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"recipient": "<string>",
"recipient_mail": "jsmith@example.com",
"visit_type": "5f2a1b9c4d3e2f0011223344",
"entrypoint_id": "5f2a1b9c4d3e2f0011223344",
"known_visitor_id": "5f2a1b9c4d3e2f0011223344",
"signed_in": "2023-11-07T05:31:56Z",
"signed_out": "2023-11-07T05:31:56Z",
"signed_in_source": 0,
"signed_out_source": 0,
"approval": "pending",
"safe": true,
"agreements": [
"5f2a1b9c4d3e2f0011223344"
],
"photo": "<string>",
"signature": "<string>",
"mod_date": "2023-11-07T05:31:56Z"
}{
"message": "<string>"
}{
"error": "Invalid API key"
}Fetching a visitor
One visit in full, including the photo and signature that the list
endpoints leave out. Both are base64-encoded images.
curl --request GET \
--url https://api.vizito.eu/api/visitors/{visitor_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vizito.eu/api/visitors/{visitor_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vizito.eu/api/visitors/{visitor_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vizito.eu/api/visitors/{visitor_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"_id": "5f2a1b9c4d3e2f0011223344",
"company_id": "5f2a1b9c4d3e2f0011223344",
"first_name": "Ada",
"last_name": "Lovelace",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"recipient": "<string>",
"recipient_mail": "jsmith@example.com",
"visit_type": "5f2a1b9c4d3e2f0011223344",
"entrypoint_id": "5f2a1b9c4d3e2f0011223344",
"known_visitor_id": "5f2a1b9c4d3e2f0011223344",
"signed_in": "2023-11-07T05:31:56Z",
"signed_out": "2023-11-07T05:31:56Z",
"signed_in_source": 0,
"signed_out_source": 0,
"approval": "pending",
"safe": true,
"agreements": [
"5f2a1b9c4d3e2f0011223344"
],
"photo": "<string>",
"signature": "<string>",
"mod_date": "2023-11-07T05:31:56Z"
}{
"message": "<string>"
}{
"error": "Invalid API key"
}Authorizations
An API key issued in the Backoffice, sent as Authorization: Bearer vzk_<key id>_<secret>.
A Microsoft Entra ID access token obtained with the client credentials
grant is accepted on the same header. The same value is also accepted in
an X-API-Key header.
Path Parameters
The visit id. A 24-character hexadecimal id.
^[0-9a-fA-F]{24}$"5f2a1b9c4d3e2f0011223344"
Response
The visit.
One visit. Every custom field the visit type defines is also present,
under its own field_name.
A 24-character hexadecimal id.
^[0-9a-fA-F]{24}$"5f2a1b9c4d3e2f0011223344"
A 24-character hexadecimal id.
^[0-9a-fA-F]{24}$"5f2a1b9c4d3e2f0011223344"
"Ada"
"Lovelace"
The organisation the visitor comes from.
International format.
Name of the host being visited.
A 24-character hexadecimal id.
^[0-9a-fA-F]{24}$"5f2a1b9c4d3e2f0011223344"
A 24-character hexadecimal id.
^[0-9a-fA-F]{24}$"5f2a1b9c4d3e2f0011223344"
A 24-character hexadecimal id.
^[0-9a-fA-F]{24}$"5f2a1b9c4d3e2f0011223344"
Absent while the visitor is still inside.
0 Backoffice or API, 1 kiosk, 2 contactless.
0, 1, 2 0, 1, 2 Present on visit types that screen visitors.
pending, approved, rejected Marked safe during an evacuation.
Ids of the agreements signed during this visit.
A 24-character hexadecimal id.
^[0-9a-fA-F]{24}$Base64-encoded image. Only on a single-visitor fetch.
Base64-encoded image. Only on a single-visitor fetch.

