OAuth Access Token

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

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
Example: "ullam"
app_secretstringrequired
Example: "et"
grant_typestringrequired
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": "ullam",
    "app_secret": "et",
    "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

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

Reports

This section provides endpoints to retrieve reports of the events

Operations
Copyright © 2025 vFairs