Skip to main content
GET
Listing expected visitors

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"

visiting_on
string
required

The day, as YYYY-MM-DD or a full ISO 8601 timestamp.

Example:

"2026-09-03"

Query Parameters

visit_type
string

Only those expected for one visit type. Also applies that visit type's sign-in buffer and its one-sign-in-per-visitor rule.

A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

Response

The expected visitors.

_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}$
first_name
string
last_name
string
company
string
email
string<email>
phone
string
recipient
string
visit_type
string

A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

visiting_on
object

When a visit is expected. Absent means "any day".

persistent
boolean

Kept after the visit; never removed by data retention.

language
string

Language of the invitation email.

pre_registration_by_visitor
boolean

The visitor filled in their own details through the invitation.

create_date
string<date-time>
mod_date
string<date-time>
alreadySignedIn
boolean

Present when visit_type was given and they are inside.