Skip to main content
GET
Listing fields

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

visit_types
string[]

Restrict to one or more visit type ids.

A 24-character hexadecimal id.

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

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

Example:

"en"

split_by_visit_type
boolean
default:false

Response

The fields.

field_name
string

The key you send and read.

Example:

"badgenumber"

field_description
string

The label as the visitor sees it.

column_title
string

The label as the Backoffice column is headed.

field_content_type
enum<string>
Available options:
text,
number,
list,
check,
yes_no,
datetime
field_status
enum<string>

Enforced in the front office, not by this API.

Available options:
required,
optional,
hidden,
disabled
visit_type_id
string

A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

list_values
object[]
field_validation
object