Event
/
Get Event Details

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
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

This section provides endpoints to authenticate vFairs event. It covers how to get an access token, manage its lifecycle, and handle event-specific access. vFairs uses OAuth 2.0 to ensure secure and controlled API access, allowing applications to authenticate safely without exposing sensitive credentials.

Operations

Attendees

This section provides endpoints to manage event attendees, including registration field retrieval, attendee creation, updates, bulk/group registrations, resume uploads, and user deletions. Secure access requires event-specific OAuth tokens. The API supports dynamic form configurations, pagination, filtering by email or user_id, and nested child_users for structured group registrations.

Operations

Session Tracks

This section provides endpoints to create, update, retrieve, and delete session tracks for multi-language events. Use track_id=0 for new tracks. Tracks require language-specific mapping via /v5/event/languages. Supports pagination, filtering, and bulk retrieval to efficiently manage localized session tracks.

Operations

Sessions

This section provides endpoints to create, update, retrieve, and delete event sessions. Use session_id=0 for new entries. Sessions can be linked to session tracks and speakers via their IDs and require language-specific entries via /v5/event/languages for multi-language support. The API supports pagination, filtering, and bulk data retrieval for efficient session management.

Operations

Session Handouts

This section provides endpoints to create, update, retrieve, and delete session handouts. Use session_handout_id=0 for new entries. Handouts are linked to sessions via their IDs, which can be retrieved from /v5/sessions. The API supports pagination, filtering, bulk retrieval, and document management to ensure seamless attendee access.

Operations

Speakers

This section provides endpoints to create, update, retrieve, and delete speaker profiles. Use speaker_id=0 for new entries. Speakers can be linked to sessions via their IDs, retrieved from /v5/sessions. The API supports dynamic form configurations, including fields like company_name and bio, and allows image handling, session associations, and deletions by speaker_id, email, or session_id.

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

Get Event Languages

Request

This endpoint is used to fetch languages available for an event.

Query
pageinteger

The page number for pagination.

Example: page=1
limitinteger

The number of records to return per page.

Example: limit=10
event_languages_onlyboolean

If true, retrieves only the languages configured for the specific event. If false, returns all available languages.

Example: event_languages_only=true
curl -i -X GET \
  'https://api.vfairs.com/rest/v5/event/languages?event_languages_only=true&limit=10&page=1' \
  -H 'Authorization: Bearer <YOUR_bearer_HERE>'

Responses

Bodyapplication/json
statusboolean
Example: true
messagestring
Example: "Successful retrieval of all languages."
dataobject
Example: {"languages":[{"id":1,"name":"English","prefix":"en"},{"id":2,"name":"All","prefix":"all"}],"meta":{"current_page":1,"from":1,"last_page":21,"path":"http://api.vfairs.com/rest/v5/event/languages","per_page":2,"to":2,"total":41}}
Response
application/json
{
  "status": true,
  "message": "Successful retrieval of all languages.",
  "data": {
    "languages": [ … ],
    "meta": { … }
  }
}

Get Event Details

Request

This endpoint is used to fetch details of an event.

Query
app_idinteger

Fetch by app ID.

Example: app_id=1
curl -i -X GET \
  'https://api.vfairs.com/rest/v5/event/getEventDetails?app_id=1' \
  -H 'Authorization: Bearer <YOUR_bearer_HERE>'

Responses

Successful retrieval of event details

Bodyapplication/json
statusboolean
Example: true
messagestring
Example: "Successful retrieval of event details."
event_detailsobject
Example: {"id":"22079","name":"Military Spousal Employment Network","url":"event.vfairs.com","start_date":"2024-01-19T08:00:00Z","end_date":"2025-01-21T18:00:00Z","ondemand_start_date":"2025-01-21T18:00:01Z","ondemand_end_date":"2028-01-23T01:49:28Z","mode":"virtual","type":"Virtual Trade Show","country":"United States","default_language":"english","enabled_languages":["english"],"organization_id":"1038","organization_name":"Shaw Industries","project_manager":{"name":"Osama Sarwar","email":"mosama@vfairs.com"},"customer_success_manager":{"name":"Osama Sarwar","email":"mosama@vfairs.com"},"event_poc":{"name":"Osama Sarwar","email":"mosama@vfairs.com"}}
Response
application/json
{
  "status": true,
  "message": "Successful retrieval of event details.",
  "event_details": {
    "id": "22079",
    "name": "Military Spousal Employment Network",
    "url": "event.vfairs.com",
    "start_date": "2024-01-19T08:00:00Z",
    "end_date": "2025-01-21T18:00:00Z",
    "ondemand_start_date": "2025-01-21T18:00:01Z",
    "ondemand_end_date": "2028-01-23T01:49:28Z",
    "mode": "virtual",
    "type": "Virtual Trade Show",
    "country": "United States",
    "default_language": "english",
    "enabled_languages": [ … ],
    "organization_id": "1038",
    "organization_name": "Shaw Industries",
    "project_manager": { … },
    "customer_success_manager": { … },
    "event_poc": { … }
  }
}

Reports

This section provides endpoints to retrieve reports of the events

Operations
Copyright © 2025 vFairs