Exporting the visitor log

GET /visitors/export/bycompany/{company_id}

Returns the visitor log as an XLSX file, with the same columns and translated headers as the Backoffice export.

Path parameters

string

required

The location.

Query parameters

integer

Rows per page, at most 200.

integer

1-based page. Pass both count and page, or neither.

string

default:"en"

Language for the column headers.

string

Same filters as Listing visitors.

string

Same sorting as the visitor log.

Response

The file itself, as an XLSX attachment.

cURL

curl -G https://api.vizito.eu/api/visitors/export/bycompany/5f2a1b9c4d3e2f0011223344 \
  -H "Authorization: Bearer $VIZITO_API_KEY" \
  -d count=200 -d page=1 \
  -o visitors.xlsx

Status	Body	Meaning
`200`	XLSX	The export
`400`	`{ "message": "Dataset too large." }`	`count` above 200
`400`	`{ "message": "No data." }`	Nothing matched the filter
`400`	`Either both or neither of count and page must be provided.`	Only one of the two was sent

The export is capped at 200 rows per call. For a bulk pull, page through Listing visitors instead: it returns JSON and has no such ceiling.

Exporting requires an administrator. An API key is a global admin on its locations, so it qualifies — but a Basic-auth integration signing in as a receptionist does not.

Getting started

Locations

Visitors

Registered visitors

Hosts

Visit types

Entry points

Agreements

Devices

Reporting

Webhooks

Exporting the visitor log

Path parameters

Query parameters

Response

​Path parameters

​Query parameters

​Response

Path parameters

Query parameters

Response