curl --request GET \
--url https://api.vizito.eu/api/companies/{company_id}/agreements \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vizito.eu/api/companies/{company_id}/agreements', 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}/agreements"
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}/agreements",
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",
"name": "<string>",
"active": true,
"type": "text",
"agreement_text": {},
"visit_types": [
"5f2a1b9c4d3e2f0011223344"
],
"version": 123,
"index": 123,
"expiry_days": 123,
"group_only": true
}
]{
"error": "Invalid API key"
}{
"message": "<string>"
}Listing agreements
The documents visitors sign, in presentation order. Deleted and archived agreements are left out.
curl --request GET \
--url https://api.vizito.eu/api/companies/{company_id}/agreements \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vizito.eu/api/companies/{company_id}/agreements', 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}/agreements"
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}/agreements",
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",
"name": "<string>",
"active": true,
"type": "text",
"agreement_text": {},
"visit_types": [
"5f2a1b9c4d3e2f0011223344"
],
"version": 123,
"index": 123,
"expiry_days": 123,
"group_only": true
}
]{
"error": "Invalid API key"
}{
"message": "<string>"
}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
true returns only the agreements currently presented.
Language for configured text, e.g. nl. Falls back to English.
"en"
Response
The agreements.
A 24-character hexadecimal id.
^[0-9a-fA-F]{24}$"5f2a1b9c4d3e2f0011223344"
text, pdf, video The text, keyed by language code.
Show child attributes
Show child attributes
A 24-character hexadecimal id.
^[0-9a-fA-F]{24}$Bumped when the content changes.
How long a signature stays valid.

