Listing visit types

GET /companies/{company_id}/visittypes

A visit type is one sign-in flow: the questions asked, the agreements to sign, whether a badge is printed, who is notified. This endpoint returns the light list — ids and names, in the order the kiosk shows them.

Path parameters

string

required

The location.

Query parameters

boolean

true returns only visit types that are not deleted and are shown on the kiosk.

string

default:"en"

Language for the names.

Response

string

Visit type id — what you send as visit_type.

object

{ "description": "Visitor" } in the requested language.

number

Position on the kiosk.

boolean

Whether visitors can pick it themselves.

boolean

Retired visit types stay in the list so old visits keep their name.

object

Badge printing settings.

curl -G https://api.vizito.eu/api/companies/5f2a1b9c4d3e2f0011223344/visittypes \
  -H "Authorization: Bearer $VIZITO_API_KEY" \
  -d active=true

[
  {
    "_id": "5f2a1b9c4d3e2f0011223399",
    "name": { "description": "Visitor" },
    "index": 0,
    "show_on_tablet": true,
    "deleted": false
  },
  {
    "_id": "5f2a1b9c4d3e2f00112233aa",
    "name": { "description": "Contractor" },
    "index": 1,
    "show_on_tablet": true,
    "deleted": false
  }
]

Visit type ids never change. Resolve them once at setup and store them in your own configuration rather than matching on the name.

Getting started

Locations

Visitors

Registered visitors

Hosts

Visit types

Entry points

Agreements

Devices

Reporting

Webhooks

Listing visit types

Path parameters

Query parameters

Response

​Path parameters

​Query parameters

​Response

Path parameters

Query parameters

Response