Skip to main content
The complete configuration of one visit type, including its fields array, its notification settings and its email templates.

Path parameters

string
required
The location.
string
required
The visit type.

Query parameters

string
Returns the configured texts in that language, falling back to English.

Response

string
The visit type id.
object
Its name.
array
The questions this flow asks — see Listing fields for the shape.
object
Badge printing settings, including whether a badge prints on kiosk and on Backoffice sign-in.
object
How the host is told: email, SMS, Teams, Slack, and the message templates.
boolean
When true, visits start with approval: "pending".
number
How far ahead of their slot an expected visitor may sign in.
string
Country code prefixed to phone numbers that do not start with +.
cURL
Visit types can be created and changed over the API, but their configuration is broad, deeply nested and translated into every language the location offers. Read them here; edit them in the Backoffice.