OAuth Access Token
/
Get Access Token

API Documentation (v5)

MethodEndpointDescription
POST/v5/oauth/tokenGenerate an OAuth access token
GET/v5/forms/attendeeFieldsRetrieve attendee form fields
POST/v5/users/attendeesCreate or update an attendee
GET/v5/users/attendeesRetrieve all attendees
POST/v5/users/attendees/{attendeeId}/resumeUpload an attendee's resume
DELETE/v5/users/attendees/{attendeeId}/deleteRemove an attendee
POST/v5/sessions/sessionTracksCreate or update a session track
GET/v5/sessions/sessionTracksRetrieve all session tracks
DELETE/v5/sessions/sessionTracks/{id}Delete a session track
POST/v5/sessionsCreate or update a session
GET/v5/sessionsRetrieve all sessions
DELETE/v5/sessions/{id}Delete a session
POST/v5/sessions/sessionHandoutsUpload or update a session handout
GET/v5/sessions/sessionHandoutsRetrieve all session handouts
DELETE/v5/sessions/sessionHandouts/{id}Remove a session handout
GET/v5/forms/speakerFieldsRetrieve speaker form fields
POST/v5/users/speakersCreate or update a speaker profile
GET/v5/users/speakersRetrieve all speakers
DELETE/v5/users/speakersRemove a speaker profile
GET/v5/event/languagesRetrieve available event languages
GET/v5/event/getEventDetailsGet detailed event information
GET/v5/reports/qrScanAnalyticsRetrieve QR scan analytics
GET/v5/reports/userJourneyAnalyticsRetrieve user journey analytics
POST/v5/boothsCreate or update a booth
GET/v5/boothsRetrieve all booths
DELETE/v5/boothsRemove a booth and optionally its representatives
GET/v5/forms/boothRepFieldsRetrieve booth representative form fields
POST/v5/users/boothRepsCreate or update a booth representative
GET/v5/users/boothRepsRetrieve all booth representatives
DELETE/v5/users/boothReps/{boothRepId}Remove a booth representative
POST/v5/floorsCreate or update a floor
GET/v5/floorsRetrieve all floors
DELETE/v5/floors/{floorId}Remove a floor and all its associated booths
POST/v5/booths/documentsCreate or update a booth document
GET/v5/booths/documentsRetrieve all booth documents
DELETE/v5/booths/documents/{documentId}Remove a booth document
POST/v5/booths/videosCreate or update a booth video
GET/v5/booths/videosRetrieve all booth videos
DELETE/v5/booths/videos/{videoId}Remove a booth video
Download OpenAPI description
Download Postman
Download OpenApi
Overview
Integrations

integrations@vfairs.com

Languages
Servers
US

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

CA

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

EU

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

UK

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

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 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
Copyright © 2025 vFairs