GET

expos/[event_id]

Specifying an ID returns a rich set of configuration information about the requested event.

Mandatory Parameters

Sample Response​

{
  "contactEmail": "\"Event 1\" ",
  "customFields": [
    {
      "customCode": "#custom:myCustomField#",
      "id": "1z1evja4k",
      "name": "myCustomField",
      "revision": 7657216554,
      "value": "one"
    }
  ],
  "description": null,
  "end": "2023-03-09T23:59:59Z",
  "forms": [
    {
      "description": "",
      "id": "2uqnrsiyndvqz",
      "name": "Visitor Registration",
      "pspMode": "test",
      "senderEmail": "",
      "url": ""
    },
    {
      "description": "",
      "id": "04s0bhjl48h6d",
      "name": "Exhibitor Registration",
      "pspMode": "test",
      "senderEmail": "",
      "url": ""
    }
  ],
  "id": "1nql0fol7vn8l",
  "locations": [
    {
      "direction": null,
      "id": "1z80xvank",
      "name": "Entrance S2"
    },
    {
      "direction": null,
      "id": "1z80xvanl",
      "name": "Entrance S3"
    }
  ],
  "name": "Event 1",
  "partnerSettings": [
    {
      "registrationType": {
        "id": "1yfopbwhk",
        "name": "Exhibitor",
        "reference": null
      },
      "staff": [
        {
          "freeBadges": null,
          "id": "1yizgi5qx",
          "name": "Exhibitor"
        }
      ]
    }
  ],
  "questions": [
    {
      "level": "expo",
      "name": "*CONTRACTOR_YOUR_DETAILS",
      "numberOfColumns": 1,
      "reference": null,
      "type": "checkBox"
    },
    {
      "answers": [
        {
          "id": "1ylzo6hwb",
          "name": "",
          "reference": null,
          "sort": 0,
          "type": "smallText"
        }
      ],
      "level": "expo",
      "name": "*CONTRACTOR_ONSITE_MOBILE_NUMBER",
      "numberOfColumns": 1,
      "reference": null,
      "type": "open"
    },
    {
      "level": "expo",
      "name": "*CONTRACTOR_EXHIBITOR_DETAILS",
      "numberOfColumns": 1,
      "reference": null,
      "type": "checkBox"
    }
  ],
  "reference": "NAM23FLD",
  "registrationTypeStats": [
    {
      "id": "1yfopbwhd",
      "name": "Visitor",
      "noshow": 41,
      "online": 41,
      "onsite": 0,
      "show": 0,
      "total": 41
    },
    {
      "id": "1yizgi5qx",
      "name": "Exhibitor",
      "noshow": 12,
      "online": 12,
      "onsite": 0,
      "show": 0,
      "total": 12
    }
  ],
  "registrationTypes": [
    {
      "id": "1ywharcvn",
      "level": "organization",
      "name": "Catering",
      "type": "visitor"
    },
    {
      "id": "1yq1w5wiv",
      "level": "organization",
      "name": "Conference Delegate",
      "type": "visitor"
    }
  ],
  "start": "2023-03-09T00:00:00Z",
  "timezone": "Europe/Amsterdam",
  "translations": [
    {
      "default": true,
      "description": "Based on language English",
      "id": "3h9j1ar63sel8",
      "iso": "EN",
      "language": "English",
      "name": "English"
    },
    {
      "description": "French language",
      "id": "2govf8iy41jlp",
      "iso": "FR",
      "language": "French",
      "name": "Français"
    }
  ]
}

Field List

Core information is identical to the fields returned in the events list:

field	type	description
customFields	mandatory array	list of custom fields defined for the event
forms	forms	list of forms defined for the event
locations	mandatory array	list of locations defined for the event
partnerSettings	mandatory array	list of partner settings defined for the event
questions	mandatory array	list of questions configured for the event
registrationTypeStats	mandatory array	list of registration type statistics for the event
registrationTypes	mandatory array	list of registration types configured for the event
translations	mandatory array	list of translations configured for the event

Custom Fields

An array of custom fields available to the event. Custom Fields provide a mechanism for organizers to attach additional properties to their events. They are defined at organisation level, therefore are applicable to all events within that organization. Custom fields may be inserted using the #merge# format throughout the Visit system, including forms, JavaScript, email templates and documents. By default custom fields are null, unless they have been assigned a value for the requested event.

Forms

An array of forms configured for the event. Forms are used in one of three ways:

• Online through a web browser, accessed by URL
• Online within Visit Connect, to add exhibiting staff or invitees
• Onsite within Visit Check-In terminals

field	type	description
id	string	Visit’s alphanumeric unique ID for the merge field
name	string	the name of the form as seen in the Visit user interface. This property is not public facing unless using the #form_name# merge field.
pspMode	enum	for use when integrating with payment gateways. test indicates fictitious transactions are processed. A form capturing real payments will have this setting as live. This mode is configurable within form builder.
senderEmail	string	exposes the email address to be used for notifications associated with the form. If empty, the email as defined in the event properties is used. To send emails using a 3rd party’s domain, it’s necessary the appropriate SPF settings are in place within the DNS settings.
url	string	the URL to the form

An array of locations configured for the event. Locations are either gates or areas. A gate can be considered as a physical entrance/exit such as door, while an area allows gates to be grouped together and represents a physical space. For example, a presentation room may have entrances and exits associated with it. Each of these is a gate. When using Visit’s tracking solutions, visitor activities are logged against a gate location. Areas may be used for functions including capacity management, limiting the number of individuals in a space.

Locations

field	type	description
direction	nullable string	possible values are in, out and camera. Camera is used for devices which automate head counting (thus provide counts in both directions). Note that cameras do not generate scans for individual visitors, but are used for capacity management functionality. When using a badge scanner, these should be associated with an in or out direction.
id	string	Visit’s alphanumeric unique ID for the location
name	string	the name of the location, as used in the Visit UI and associated scanning systems

Partner Settings

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.

Questions

An array of questions used in the requested event. A large number of questions may be exposed through the visit user interface as questions may be set up at ‘organization’ level and shared between multiple events. Questions exposed in the API are limited to those which are in use on the event’s registration forms.

Registration Type Statistics

An array of activitiy summaries for each of the visitor registration types in use at the event.

field	type	description
id	string	Visit’s alphanumeric unique ID for the registration type
name	string	registration type name
noshow	integer	total number of non-attendees (= total – show)
online	integer	total number of online registrants
onsite	integer	total number of onsite registrants (registrants through Visit check-in terminals)
show	integer	total number of attendees (= total – noshow)
total	integer	total number of complete visitor registrations (registration-state=show)

Registration Types

An array of registration types available to the event. All partners have a partner registration type, and all visitors who have completed the registration process (their registration-state is registered) have a visitor registration type. Although partner and visitor registration types may have the same names, they are not interchangeable.

field	type	description
id	string	Visit’s alphanumeric unique ID for the registration type
level	enum	either event or organization. An organization level registration type is available to all events for a given Visit client. An event level registration type cannot be exposed outside of the requested event.
name	string	the name of the registration type
type	enum	either visitor or partner

Translations

An array of translations in use within the requested events.

field	type	description
default	boolean	when multiple languages are available for a form, one of the languages will expose: true. Other languages will expose false. The default language is configurable in the Visit UI.
description	enum	description of the translation
id	string	Visit’s alphanumeric unique ID for the translation
iso	string	ISO2 code of the base language for this translation. Example: EN
language	string	ISO name of the base language for this translation. Example: English
name	string	name of the translation