Skip to main content
GET
Listing visit types

Authorizations

Authorization
string
header
required

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

company_id
string
required

The location. A 24-character hexadecimal id.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5f2a1b9c4d3e2f0011223344"

Query Parameters

active
boolean

true returns only visit types shown on the kiosk.

language_id
string

Language for configured text, e.g. nl. Falls back to English.

Example:

"en"

Response

The visit types.

_id
string

A 24-character hexadecimal id.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5f2a1b9c4d3e2f0011223344"

name
object
index
integer

Position on the kiosk.

show_on_tablet
boolean
deleted
boolean

Retired visit types stay listed so old visits keep their name.

printing
object