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

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

Get Speaker Form Fields

Request

Retrieves the dynamic form configuration for speaker registration. Returns field definitions including validation rules and data types required for speaker creation.

Security

default

curl -i -X GET \
  https://api.vfairs.com/rest/v5/forms/speakerFields \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "Successful retrieval of session speaker registation fields."

collectionArray of objects

Example: [{"id":108905,"title":"First Name","slug":"first_name","is_required":true,"status":true,"type":"text"},{"id":108906,"title":"Last Name","slug":"last_name","is_required":true,"status":true,"type":"text"},{"id":108907,"title":"Email","slug":"email","is_required":true,"status":true,"type":"text"},{"id":108917,"title":"Webinar","slug":"session_ids","is_required":true,"status":true,"type":"select"}]

Response

application/json

{
  "status": true,
  "message": "Successful retrieval of session speaker registation fields.",
  "collection": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Create/Update Speaker

Request

Creates a new speaker profile or updates an existing one. Supports session associations and dynamic form field mapping based on event configuration.

Security

default

Bodyapplication/json

speaker_idinteger

Unique identifier of the speaker. Use 0 or omit for new speaker creation. Required for updating existing speakers.

Example: 0

emailstring

Email address of the speaker. Required when creating a new speaker (speaker_id is null).

Example: "QA7@vfairs.com"

first_namestring

First name of the speaker. Required when creating a new speaker (speaker_id is null).

Example: "QA"

last_namestring

Last name of the speaker. Required when creating a new speaker (speaker_id is null).

Example: "007"

statusinteger

Activation status of the speaker. Use 1 to activate or 0 to deactivate.

Example: 1

external_idstring

External system identifier for the speaker.

Example: "EXT-123"

user_imagestring

CDN URL of the speaker's profile image.

Example: "https://cdn.example.com/speaker.jpg"

has_paidinteger

Payment status indicator. Use 1 if speaker has paid or 0 if not paid.

Example: 1

company_namestring

Company or organization name of the speaker.

Example: "VFairs"

biostring

Biography or description of the speaker.

Example: "Experienced technology speaker with 10+ years in the industry."

session_idsArray of strings

Array of session identifiers to associate with the speaker. Each ID must correspond to an existing session. See /sessions for available sessions.

Example: [123,456]

skip_speaker_creationboolean

Controls speaker creation behavior. If true, only associates existing speaker with sessions without creating a new user record. If false, creates speaker as a new user and associates with sessions.

Example: true

curl -i -X POST \
  https://api.vfairs.com/rest/v5/users/speakers \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "speaker_id": 0,
    "email": "QA7@vfairs.com",
    "first_name": "QA",
    "last_name": "007",
    "status": 1,
    "external_id": "EXT-123",
    "user_image": "https://cdn.example.com/speaker.jpg",
    "has_paid": 1,
    "company_name": "VFairs",
    "bio": "Experienced technology speaker with 10+ years in the industry.",
    "session_ids": [
      123,
      456
    ],
    "skip_speaker_creation": true
  }'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

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

speaker_detailsobject

Example: {"session_ids":[123],"action_type":"skipped_speaker_creation"}

Response

application/json

{
  "status": true,
  "message": "Session Speaker(s) created successfully.",
  "speaker_details": {
    "session_ids": [ … ],
    "action_type": "skipped_speaker_creation"
  }
}

Get Speakers

Request

Retrieves a paginated list of speakers for the event. Supports filtering by speaker details and session associations.

Security

default

Query

pageinteger

Page number for pagination.

Example: page=1

limitinteger

Number of records to return per page.

Example: limit=12

speaker_emailstring

Email address to filter speakers by.

Example: speaker_email=qa5@gmail.com

speaker_idinteger

Unique identifier to filter speakers by.

Example: speaker_id=123654

session_idinteger

Session identifier to filter speakers by. Must correspond to an existing session. See /sessions for available sessions.

Example: session_id=52675

fetch_session_speakersboolean

Controls speaker filtering by session association. If true, returns only speakers associated with sessions. If false, returns all speakers regardless of session association.

Example: fetch_session_speakers=false

curl -i -X GET \
  'https://api.vfairs.com/rest/v5/users/speakers?fetch_session_speakers=false&limit=12&page=1&session_id=52675&speaker_email=qa5%40gmail.com&speaker_id=123654' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "Successful retrieval of session speakers."

speakersArray of objects

Example: [{"speaker_id":644447998,"name":"NUM Xyz","email":"test20+12@vfairs.com","first_name":"NUM","last_name":"Xyz","biography":"Session","company_name":"VFairs","profile_picture":"xx","sessions":[2171861]}]

metaobject

Example: {"current_page":1,"from":1,"last_page":1,"path":"http://api.vfairs.com/rest/v5/users/speakers","per_page":10,"to":1,"total":1}

Response

application/json

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

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

Sessions

Session Handouts

Speakers

Get Speaker Form Fields

Request

Responses

Was this helpful?

Create/Update Speaker

Request

Responses

Was this helpful?

Get Speakers

Request

Responses

Was this helpful?

Booths

Booth Documents

Booth Videos

Floors

Event

Reports