API Documentation

Method	Endpoint	Description
`POST`	{{server}}/v5/oauth/token	Generate an OAuth access token
`POST`	{{server}}/v5/users/attendees	Create or update an attendee
`GET`	{{server}}/v5/users/attendees	Retrieve all attendees
`POST`	{{server}}/v5/users/attendees/{attendeeId}/resume	Upload an attendee's resume
`DELETE`	{{server}}/v5/users/attendees/{attendeeId}/delete	Remove an attendee
`POST`	{{server}}/v5/users/speakers	Create or update a speaker profile
`GET`	{{server}}/v5/users/speakers	Retrieve all speakers
`DELETE`	{{server}}/v5/users/speakers	Remove a speaker profile
`POST`	{{server}}/v5/users/boothReps	Create or update a booth representative
`GET`	{{server}}/v5/users/boothReps	Retrieve all booth representatives
`DELETE`	{{server}}/v5/users/boothReps/{boothRepId}	Remove a booth representative
`POST`	{{server}}/v5/users/segments	Create or update a segment
`GET`	{{server}}/v5/users/segments	Retrieve all segments
`DELETE`	{{server}}/v5/users/segments/{segmentId}	Remove a segment
`POST`	{{server}}/v5/users/segments/rules	Create or update a segment rule
`GET`	{{server}}/v5/users/segments/rules	Retrieve all segment rules
`DELETE`	{{server}}/v5/users/segments/rules/{ruleId}	Remove a segment rule
`GET`	{{server}}/v5/forms/attendeeFields	Retrieve attendee form fields
`GET`	{{server}}/v5/forms/speakerFields	Retrieve speaker form fields
`GET`	{{server}}/v5/forms/boothRepFields	Retrieve booth representative form fields
`POST`	{{server}}/v5/sessions	Create or update a session
`GET`	{{server}}/v5/sessions	Retrieve all sessions
`DELETE`	{{server}}/v5/sessions/{id}	Delete a session
`POST`	{{server}}/v5/sessions/sessionTracks	Create or update a session track
`GET`	{{server}}/v5/sessions/sessionTracks	Retrieve all session tracks
`DELETE`	{{server}}/v5/sessions/sessionTracks/{id}	Delete a session track
`POST`	{{server}}/v5/sessions/sessionHandouts	Upload or update a session handout
`GET`	{{server}}/v5/sessions/sessionHandouts	Retrieve all session handouts
`DELETE`	{{server}}/v5/sessions/sessionHandouts/{id}	Remove a session handout
`POST`	{{server}}/v5/booths	Create or update a booth
`GET`	{{server}}/v5/booths	Retrieve all booths
`DELETE`	{{server}}/v5/booths	Remove a booth and optionally its representatives
`POST`	{{server}}/v5/booths/documents	Create or update a booth document
`GET`	{{server}}/v5/booths/documents	Retrieve all booth documents
`DELETE`	{{server}}/v5/booths/documents/{documentId}	Remove a booth document
`POST`	{{server}}/v5/booths/videos	Create or update a booth video
`GET`	{{server}}/v5/booths/videos	Retrieve all booth videos
`DELETE`	{{server}}/v5/booths/videos/{videoId}	Remove a booth video
`POST`	{{server}}/v5/floors	Create or update a floor
`GET`	{{server}}/v5/floors	Retrieve all floors
`DELETE`	{{server}}/v5/floors/{floorId}	Remove a floor and all its associated booths
`GET`	{{server}}/v5/event/languages	Retrieve available event languages
`GET`	{{server}}/v5/event/getEventDetails	Get detailed event information
`GET`	{{server}}/v5/reports/qrScanAnalytics	Retrieve QR scan analytics
`GET`	{{server}}/v5/reports/userJourneyAnalytics	Retrieve user journey analytics

Download OpenAPI description

Download Postman

Download OpenApi

Overview

Integrations

integrations@vfairs.com

Servers

https://api.vfairs.com/rest/

https://api.vfairs.ca/rest/

https://api-eu.vfairs.com/rest/

https://api-uk.vfairs.com/rest/

KSA

https://api-ksa.vfairs.com/rest/

OAuth Access Token

Endpoints for obtaining and managing OAuth access tokens for API authentication.

Operations

Get Access Token

Request

Obtain the app_key and app_secret as described in the authentication section, and then call the token endpoint to obtain access token. By default, the token has an expires_in value of 1440 minutes (24 hours).

Token Caching:

Option 1: vFairs automatically caches the token for 24 hours and uses the cached token for subsequent token endpoint requests.
Option 2: Clients can store the token and its expires_in value locally.

When the expires_in value reaches 0:

For Option 1: No action is required. vFairs will automatically generate and return a new token.
For Option 2: Clients must call the token endpoint again to obtain a new token.

Does the access token work for all events?

No, each event hosted within vFairs has a unique app_key. You need to generate a secret_key and obtain an access token separately for each event to call the endpoints.

Bodyapplication/jsonrequired

app_keystringrequired

The event app key.

Example: "OkPdi5D526sW79xxxxxxxxx"

app_secretstringrequired

The event secret key.

Example: "sk-1724238547-5226462-ce059ef4192xxxxxxx"

grant_typestringrequired

The value of grant_type will always be client_credentials.

Value"client_credentials"

Example: "client_credentials"

curl -i -X POST \
  https://api.vfairs.com/rest/v5/oauth/token \
  -H 'Content-Type: application/json' \
  -d '{
    "app_key": "OkPdi5D526sW79xxxxxxxxx",
    "app_secret": "sk-1724238547-5226462-ce059ef4192xxxxxxx",
    "grant_type": "client_credentials"
  }'

Responses

Bodyapplication/json

access_tokenstring

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

token_typestring

Example: "Bearer"

expires_ininteger

Example: 1440

Response

application/json

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 1440
}

Attendees

Manages attendee data for events, including registration, profile updates, resume uploads, and form field configuration. These endpoints enable comprehensive attendee lifecycle management from registration through event participation.

Operations

User Segments

Manages user segments for the current event. User segments are used to target specific groups of users for marketing and communication purposes.

Operations

User Segment Rules

Manages user segment rules for the current event. User segment rules define criteria-based targeting for specific groups of users.

Operations

Session Tracks

Manages session tracks for multi-language events. Session tracks organize sessions by categories, dates, or themes and support localization through language-specific configurations.

Operations

Sessions

Manages event sessions including creation, updates, retrieval, and deletion. Sessions can be linked to tracks and speakers, support multi-language configurations, and offer various session types for different event formats.

Operations

Session Handouts

Endpoints for managing session handouts - documents associated with sessions that attendees can view or download.

Operations

Speakers

Endpoints for managing speaker profiles and their session associations. Speakers can be created, updated, retrieved, and deleted, with support for dynamic form configurations and session linking.

Operations

Booths

Manages virtual exhibition booths where exhibitors showcase products, services, and company information. Booths are organized within floors and can include representatives, videos, documents, and interactive features with customizable layouts and access permissions.

Operations

Booth Representatives

Manages booth representatives who interact with visitors in virtual exhibition booths. Representatives can be assigned to multiple booths and have specific roles and permissions.

Operations

Booth Documents

Manage booth documents including PDFs, Word documents, Excel spreadsheets, and PowerPoint presentations. Exhibitors can share these documents with booth visitors, and documents can be automatically added to visitor briefcases.

Operations

Booth Videos

Manages booth videos for events. Videos can showcase products, provide demonstrations, or share company information. Supported formats include MP4, MOV, WMV, AVI, and FLV.

Operations

Floors

Manages virtual floors within events. Floors organize booths in a virtual event space and can be customized with different layouts and themes.

Operations

Event

This section provides endpoints to retrieve event metadata, including available languages for multi-language configuration and detailed event information. These endpoints are essential for localizing content such as sessions and tracks and integrating event-specific settings to ensure a seamless and customized event experience.

Operations

Reports

Endpoints for retrieving event analytics and reporting data including QR scan analytics and user journey reports.

Operations

API Documentation

OAuth Access Token

Get Access Token

Request

Responses

Was this helpful?

Attendees

User Segments

User Segment Rules

Session Tracks

Sessions

Session Handouts

Speakers

Booths

Booth Representatives

Booth Documents

Booth Videos

Floors

Event

Reports