Skip to main content
GET
Listing visitors inside

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

datetimestamp
string<date-time>

The day to evaluate. Defaults to today.

Response

The visitors currently inside.

_id
string

A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

company_id
string

A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

first_name
string
Example:

"Ada"

last_name
string
Example:

"Lovelace"

company
string

The organisation the visitor comes from.

email
string<email>
phone
string

International format.

recipient
string

Name of the host being visited.

recipient_mail
string<email>
visit_type
string

A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

entrypoint_id
string

A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

known_visitor_id
string

A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

signed_in
string<date-time>
signed_out
string<date-time>

Absent while the visitor is still inside.

signed_in_source
enum<integer>

0 Backoffice or API, 1 kiosk, 2 contactless.

Available options:
0,
1,
2
signed_out_source
enum<integer>
Available options:
0,
1,
2
approval
enum<string>

Present on visit types that screen visitors.

Available options:
pending,
approved,
rejected
safe
boolean

Marked safe during an evacuation.

agreements
string[]

Ids of the agreements signed during this visit.

A 24-character hexadecimal id.

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

Base64-encoded image. Only on a single-visitor fetch.

signature
string

Base64-encoded image. Only on a single-visitor fetch.

mod_date
string<date-time>