Skip to main content
GET
Listing hosts, paged

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

count
integer
required

Rows to return.

Required range: x >= 1
Example:

50

page
integer
required

1-based page number.

Required range: x >= 1
Example:

1

sorting
object

Sort per field, as sorting[signed_in]=desc. asc or desc.

filter
object

Filter per field, as filter[company]=acme. Values match case-insensitively on any part of the stored value. A date field takes a range instead: filter[signed_in][startDate] and filter[signed_in][endDate], both ISO 8601.

Response

One page of hosts.

total
integer
visitees
object[]