Get Session Tracks

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

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

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

Create/Update Session Track

Request

This endpoint is used to create or update session tracks information for the event. When creating a new session track, the track_id value is 0 or null.

For events with multiple languages, use the Get Languages endpoint to retrieve language IDs. Create a session track for each language to ensure it can be associated with the corresponding language session.

Bodyapplication/jsonrequired

track_idinteger

The id of the track, required while updating the record.

Example: 0

namestringrequired

The name of the track.

Example: "New Session"

language_idintegerrequired

The language ID of the track, such as 1 for English.

Example: 1

webinar_typestringrequired

The type of the track, which can be either Poster or Session.

Enum"Poster""Session"

Example: "Poster"

parent_idinteger

To establish a parent/child session track association, set the track ID of the parent to make this track a child.

Example: 18

defaultinteger

Use 1 to set it as default to automatically select the track in the listing and display associated sessions, or 0 otherwise.

Example: 1

sequenceinteger

Set the order of the track to appear in the listing in the same sequence.

Example: 1

activeinteger

The status of the track [1 to activate and 0 to deactivate].

Example: 1

curl -i -X POST \
  https://api.vfairs.com/rest/v5/sessions/sessionTracks \
  -H 'Authorization: Bearer <YOUR_bearer_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "track_id": 0,
    "name": "New Session",
    "language_id": 1,
    "webinar_type": "Poster",
    "parent_id": 18,
    "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

This endpoint is used to fetch a collection of session tracks from the event. You can customize the returned data by specifying query parameters, as the data will be fetched based on these parameters. To navigate through the entire collection, use the pagination fields included in the response.

Need details about a single track?

You can also get detailed information for an individual session track by specifying its unique track_id in the query parameters.

Query

pageinteger

The page number for pagination.

Example: page=1

limitinteger

The number of records to return per page.

Example: limit=50

track_idinteger

Filter by track ID.

Example: track_id=19824

session_typestring

Filter by session type. The session type should be one of the following: Poster or Session.

Enum"Session""Poster"

Example: session_type=Session

session_statusstring

Filter by session status. The status can be one of the following: active, inactive, or all.

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

This endpoint is used to delete a session track from the event.

Path

idstringrequired

The ID of the sessionTrack.

Example: tenetur

sessionTrackIdintegerrequired

The unique identifier of the track to be deleted.

Example: 32637

curl -i -X DELETE \
  https://api.vfairs.com/rest/v5/sessions/sessionTracks/tenetur \
  -H 'Authorization: Bearer <YOUR_bearer_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

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

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

Event

Reports