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

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

Get Floors

Request

Retrieves a paginated list of floors for the current event.

Security
default
Query
pageinteger

Page number for pagination. Defaults to 1 if not provided.

Example: page=1
limitinteger

Number of floors to return per page. Defaults to 10 if not provided.

Example: limit=10
floor_idinteger

Unique identifier of the floor to filter by. Must correspond to an existing floor within the event.

Example: floor_id=123
curl -i -X GET \
  'https://api.vfairs.com/rest/v5/floors?floor_id=123&limit=10&page=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
statusboolean
Example: true
messagestring
Example: "Floors fetched successfully."
floorsArray of objects
Example: [{"id":1,"floor_name":"Main Floor","created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T10:30:00Z"}]
metaobject
Example: {"current_page":1,"per_page":10,"total":25}
Response
application/json
{
  "status": true,
  "message": "Floors fetched successfully.",
  "floors": [
    { … }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 10,
    "total": 25
  }
}

Create or Update Floor

Request

Creates a new floor or updates an existing floor based on whether floor_id is provided.

Security
default
Bodymultipart/form-datarequired
floor_idinteger

Unique identifier of the floor to update. If provided, updates existing floor; if omitted, creates a new floor.

Example: 123
floor_namestringrequired

Display name for the floor. Must be unique within the event.

Example: "Main Exhibition Floor"
floor_background_imagestring(binary)required

Background image file for the floor. Supported formats: jpeg, png, jpg, gif, svg. Maximum file size: 2MB.

curl -i -X POST \
  https://api.vfairs.com/rest/v5/floors \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F floor_id=123 \
  -F 'floor_name=Main Exhibition Floor' \
  -F floor_background_image=string

Responses

Bodyapplication/json
statusboolean
Example: true
messagestring
Example: "Floor created successfully."
dataobject
Example: {"floor_id":123}
Response
application/json
{
  "status": true,
  "message": "Floor created successfully.",
  "data": {
    "floor_id": 123
  }
}

Delete Floor

Request

Permanently removes a floor and all associated data.

Security
default
Path
floorIdintegerrequired

Unique identifier of the floor to delete. Must correspond to an existing floor.

Example: 123
curl -i -X DELETE \
  https://api.vfairs.com/rest/v5/floors/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
statusboolean
Example: true
messagestring
Example: "Floor deleted successfully."
floor_idinteger
Example: 123
Response
application/json
{
  "status": true,
  "message": "Floor deleted successfully.",
  "floor_id": 123
}

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