API Documentation (v5)

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

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

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

Create/Update Session Track

Request

Creates a new session track or updates an existing one. For multi-language events, create separate tracks for each language to ensure proper localization.

Security

default

Bodyapplication/jsonrequired

track_idinteger

Unique identifier of the session track. Use 0 or null when creating a new track. Required when updating an existing track.

Example: 0

namestringrequired

Display name of the session track (e.g., "Day 1 Sessions", "Poster Presentations").

Example: "New Session"

language_idintegerrequired

Language identifier for the track. Must correspond to an existing event language. See /v5/event/languages for available languages.

Example: 1

webinar_typestringrequired

Type of sessions this track will contain. Determines session behavior and display options.

Enum"Poster""Session"

Example: "Poster"

parent_idinteger

Track ID of the parent track to create a hierarchical relationship. Leave null for top-level tracks.

Example: 15

defaultinteger

Default track selection flag. Use 1 to automatically select this track in listings and display its sessions, 0 otherwise.

Example: 1

sequenceinteger

Display order of the track in listings. Lower numbers appear first.

Example: 1

activeinteger

Track status flag. Use 1 to activate the track (visible and functional), 0 to deactivate (hidden from users).

Example: 1

curl -i -X POST \
  https://api.vfairs.com/rest/v5/sessions/sessionTracks \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "track_id": 0,
    "name": "New Session",
    "language_id": 1,
    "webinar_type": "Poster",
    "parent_id": 15,
    "default": 1,
    "sequence": 1,
    "active": 1
  }'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "Session Track(s) created successfully."

track_idinteger

Example: 123213

Response

application/json

{
  "status": true,
  "message": "Session Track(s) created successfully.",
  "track_id": 123213
}

Get Session Tracks

Request

Retrieves a paginated list of session tracks for the event. Supports filtering by track ID, session type, and status.

Security

default

Query

pageinteger

Page number for pagination results.

Example: page=1

limitinteger

Number of records to return per page (max 100).

Example: limit=50

track_idinteger

Unique identifier of a specific session track to retrieve. When provided, returns details for that track only.

Example: track_id=19824

session_typestring

Filter tracks by session type. Determines the type of sessions this track can contain.

Enum"Session""Poster"

Example: session_type=Session

session_statusstring

Filter tracks by status. Use "active" for enabled tracks, "inactive" for disabled tracks, or "all" for both.

Example: session_status=active

curl -i -X GET \
  'https://api.vfairs.com/rest/v5/sessions/sessionTracks?limit=50&page=1&session_status=active&session_type=Session&track_id=19824' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "Successful retrieval of session tracks."

session_tracksArray of objects

Example: [{"track_id":21629,"track_name":"18 June","is_active_track":true,"track_session_type":"Session","is_default_track":false,"track_sequence":1,"track_language":{"id":1,"name":"English","prefix":"en"},"child_tracks":[]}]

metaobject

Example: {"current_page":1,"from":1,"last_page":5,"path":"http://api.vfairs.com/rest/v5/sessions/sessionTracks","per_page":1,"to":1,"total":5}

Response

application/json

{
  "status": true,
  "message": "Successful retrieval of session tracks.",
  "session_tracks": [
    { … }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "path": "http://api.vfairs.com/rest/v5/sessions/sessionTracks",
    "per_page": 1,
    "to": 1,
    "total": 5
  }
}

Delete Session Track

Request

Permanently removes a session track from the event. This action cannot be undone and will affect any sessions associated with this track.

Security

default

Path

idstringrequired

The ID of the sessionTrack.

Example: magni

sessionTrackIdintegerrequired

Unique identifier of the session track to delete. Must correspond to an existing track owned by the authenticated user.

Example: 32637

curl -i -X DELETE \
  https://api.vfairs.com/rest/v5/sessions/sessionTracks/magni \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "Session Track deleted successfully"

dataobject

Example: {"track_id":31892}

Response

application/json

{
  "status": true,
  "message": "Session Track deleted successfully",
  "data": {
    "track_id": 31892
  }
}

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

API Documentation (v5)

OAuth Access Token

Attendees

Session Tracks

Create/Update Session Track

Request

Responses

Was this helpful?

Get Session Tracks

Request

Responses

Was this helpful?

Delete Session Track

Request

Responses

Was this helpful?

Sessions

Session Handouts

Speakers

Booths

Booth Documents

Booth Videos

Floors

Event

Reports