Skip to main content
GET
Listing agreements of a visit type

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"

visit_type_id
string
required

A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

Query Parameters

group_only
boolean

true also returns agreements shown only to the person signing in a group.

language_id
string

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

Example:

"en"

Response

The agreements.

_id
string

A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

name
string
active
boolean
type
enum<string>
Available options:
text,
pdf,
video
agreement_text
object

The text, keyed by language code.

visit_types
string[]

A 24-character hexadecimal id.

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

Bumped when the content changes.

index
integer
expiry_days
integer

How long a signature stays valid.

group_only
boolean