curl --request GET \
--url https://api.vizito.eu/api/companies/{company_id}/fields \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vizito.eu/api/companies/{company_id}/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vizito.eu/api/companies/{company_id}/fields"
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/companies/{company_id}/fields",
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;
}[
{
"field_name": "badgenumber",
"field_description": "<string>",
"column_title": "<string>",
"field_content_type": "text",
"field_status": "required",
"visit_type_id": "5f2a1b9c4d3e2f0011223344",
"list_values": [
{
"value_name": "<string>",
"value_description": "<string>",
"is_default": true
}
],
"field_validation": {
"regex": "<string>",
"message": "<string>"
}
}
]{
"error": "Invalid API key"
}Listing fields
Every question asked at a location, merged across its visit types. This is what tells you which keys a visitor or registered visitor accepts.
A custom field’s value is stored under its field_name, so two visit
types defining the same name share one key on the visit.
split_by_visit_type=true gives each its own column instead.
curl --request GET \
--url https://api.vizito.eu/api/companies/{company_id}/fields \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vizito.eu/api/companies/{company_id}/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vizito.eu/api/companies/{company_id}/fields"
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/companies/{company_id}/fields",
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;
}[
{
"field_name": "badgenumber",
"field_description": "<string>",
"column_title": "<string>",
"field_content_type": "text",
"field_status": "required",
"visit_type_id": "5f2a1b9c4d3e2f0011223344",
"list_values": [
{
"value_name": "<string>",
"value_description": "<string>",
"is_default": true
}
],
"field_validation": {
"regex": "<string>",
"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 location. A 24-character hexadecimal id.
^[0-9a-fA-F]{24}$"5f2a1b9c4d3e2f0011223344"
Query Parameters
Restrict to one or more visit type ids.
A 24-character hexadecimal id.
^[0-9a-fA-F]{24}$Language for configured text, e.g. nl. Falls back to English.
"en"
Response
The fields.
The key you send and read.
"badgenumber"
The label as the visitor sees it.
The label as the Backoffice column is headed.
text, number, list, check, yes_no, datetime Enforced in the front office, not by this API.
required, optional, hidden, disabled A 24-character hexadecimal id.
^[0-9a-fA-F]{24}$"5f2a1b9c4d3e2f0011223344"
Show child attributes
Show child attributes
Show child attributes
Show child attributes

