Get a visit type

A visit type's key. Every organisation has six built-in visit types, meeting, interview, delivery, contractor, event and other, and can add its own in the console, such as parent_pickup or vendor. Each type has its own visit form, badge and rules. A key is lowercase letters, digits and underscores, starts with a letter and is at most 40 characters. It never changes, even when the type is renamed, and it's the same in live and test mode. List your organisation's types with GET /visit-types.

A key your organisation doesn't have returns validation_failed, and so does a type that is turned off when you create a visit or change a visit's type.

The name people see on the kiosk, passes, badges and in the console. Admins can change it.

The type's icon, shown beside its name wherever people choose a visit type: on the kiosk, the visitor pages, the apps and in the console. It is the key of one icon in Agoo's set for visit types, such as handshake, package or wrench, never an image. Admins pick it in Console → Settings → Forms. Built-in types start with their own icon, and a type you add starts with user until an admin picks one.

Today's keys are handshake, briefcase, package, wrench, calendar, sparkles, user, users, star, id_card, heart, home, backpack, graduation_cap, book, map, ticket, chat, hammer, spray, laptop, shield, clipboard_check, stethoscope, heart_pulse, shopping_bag, truck, bike, car, arrow_left_right, utensils, banknote, scale, landmark, hand_heart and mic. A key never changes or goes away, and new ones may be added, so draw user for a key you don't know.

true for the six types every organisation starts with.

false when an admin has turned the type off. New visits can't use it, and creating one with it returns validation_failed. Existing visits keep their type.

true when an admin has opened the type for pre-registration. Visitors can then choose it on your pre-registration pages, in website embeds and in forms that use a publishable key. Off by default. A publishable key can only see, and create visits with, types that are turned on and have this set.

The type's visit form, which defines the custom_fields its visits accept (GET /forms/{form_id}).

The visitor-facing part of the type's visit form, for building a pre-registration form. null unless pre_registration is true.

Who a visit of this type may be for. ask and offer say what a visitor may answer to "Who are you here to see?", so a form built with a publishable key knows whether to ask and what to send: host_id for one person, host_ids for several, team_id for a team, or none of them for no one in particular. A secret key or an OAuth app may address a visit to anyone, whatever the type offers visitors. With a publishable key, only ask and offer are returned. Admins set these in Console → Visitor types.