API Documentation

Method	Endpoint	Description
`POST`	{server}/v5/oauth/token	Generate an OAuth access token
`POST`	{server}/v5/users/attendees	Create or update an attendee
`GET`	{server}/v5/users/attendees	Retrieve all attendees
`POST`	{server}/v5/users/attendees/{attendeeId}/resume	Upload an attendee's resume
`DELETE`	{server}/v5/users/attendees/{attendeeId}	Remove an attendee
`POST`	{server}/v5/users/speakers	Create or update a speaker profile
`GET`	{server}/v5/users/speakers	Retrieve all speakers
`DELETE`	{server}/v5/users/speakers/{speakerId}	Remove a speaker profile
`DELETE`	{server}/v5/users/speakers/{speakerId}/detach	Detach a speaker from all sessions
`DELETE`	{server}/v5/users/speakers/detach	Detach a speaker from sessions by email
`POST`	{server}/v5/users/boothReps	Create or update a booth representative
`GET`	{server}/v5/users/boothReps	Retrieve all booth representatives
`DELETE`	{server}/v5/users/boothReps/{boothRepId}	Remove a booth representative
`POST`	{server}/v5/users/segments	Create or update a segment
`GET`	{server}/v5/users/segments	Retrieve all segments
`DELETE`	{server}/v5/users/segments/{segmentId}	Remove a segment
`POST`	{server}/v5/users/segments/rules	Create or update a segment rule
`GET`	{server}/v5/users/segments/rules	Retrieve all segment rules
`DELETE`	{server}/v5/users/segments/rules/{ruleId}	Remove a segment rule
`GET`	{server}/v5/forms/attendeeFields	Retrieve attendee form fields
`GET`	{server}/v5/forms/speakerFields	Retrieve speaker form fields
`GET`	{server}/v5/forms/boothRepFields	Retrieve booth representative form fields
`GET`	{server}/v5/forms/boothJobsFields	Retrieve booth job form fields
`POST`	{server}/v5/sessions	Create or update a session
`GET`	{server}/v5/sessions	Retrieve all sessions
`DELETE`	{server}/v5/sessions/{sessionId}	Delete a session
`DELETE`	{server}/v5/sessions/{sessionId}/speakers/{speakerId}/detach	Detach a specific speaker from a session
`DELETE`	{server}/v5/sessions/{sessionId}/speakers/detach	Detach a speaker from a session by email
`POST`	{server}/v5/sessions/sessionTracks	Create or update a session track
`GET`	{server}/v5/sessions/sessionTracks	Retrieve all session tracks
`DELETE`	{server}/v5/sessions/sessionTracks/{id}	Delete a session track
`POST`	{server}/v5/sessions/sessionHandouts	Upload or update a session handout
`GET`	{server}/v5/sessions/sessionHandouts	Retrieve all session handouts
`DELETE`	{server}/v5/sessions/sessionHandouts/{id}	Remove a session handout
`POST`	{server}/v5/booths	Create or update a booth
`GET`	{server}/v5/booths	Retrieve all booths
`DELETE`	{server}/v5/booths	Remove a booth and optionally its representatives
`POST`	{server}/v5/booths/documents	Create or update a booth document
`GET`	{server}/v5/booths/documents	Retrieve all booth documents
`DELETE`	{server}/v5/booths/documents/{documentId}	Remove a booth document
`POST`	{server}/v5/booths/videos	Create or update a booth video
`GET`	{server}/v5/booths/videos	Retrieve all booth videos
`DELETE`	{server}/v5/booths/videos/{videoId}	Remove a booth video
`GET`	{server}/v5/booths/jobs/categories	Retrieve available job categories
`POST`	{server}/v5/booths/{boothId}/jobs	Create or update a booth job vacancy
`GET`	{server}/v5/booths/{boothId}/jobs	Retrieve job vacancies for a specific booth
`DELETE`	{server}/v5/booths/{boothId}/jobs/{jobId}	Remove a booth job vacancy
`POST`	{server}/v5/floors	Create or update a floor
`GET`	{server}/v5/floors	Retrieve all floors
`DELETE`	{server}/v5/floors/{floorId}	Remove a floor and all its associated booths
`GET`	{server}/v5/countries	Retrieve available countries
`GET`	{server}/v5/countries/{countryId}/regions	Retrieve regions for a specific country
`GET`	{server}/v5/countries/regions/{regionId}/cities	Retrieve cities for a specific region
`GET`	{server}/v5/event/languages	Retrieve available event languages
`GET`	{server}/v5/event/getEventDetails	Get detailed event information
`GET`	{server}/v5/reports/qrScanAnalytics	Retrieve QR scan analytics
`GET`	{server}/v5/reports/userJourneyAnalytics	Retrieve user journey analytics

Download OpenAPI description

Download OpenApiDescription

Download Postman Collection (vFairs)

Overview

Integrations

integrations@vfairs.com

Servers

Mock server

https://developers.vfairs.com/_mock/apis/

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

Get Attendee Form Fields

Request

Retrieves all available registration form fields configured for the event. Use the slug values as keys when creating or updating attendees.

Security

BearerToken

curl -i -X GET \
  https://developers.vfairs.com/_mock/apis/v5/forms/attendeeFields \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "User registration fields fetched."

fieldsArray of objects

Example: [{"id":1383524,"title":"First Name","slug":"first_name","is_required":true,"status":true,"type":"text"},{"id":1383525,"title":"Last Name","slug":"last_name","is_required":true,"status":true,"type":"text"}]

Response

application/json

{
  "status": true,
  "message": "User registration fields fetched.",
  "fields": [
    { … },
    { … }
  ]
}

Create/Update Attendee

Request

Creates a new attendee or updates an existing attendee record. Supports group registrations through child users.

Security

BearerToken

Bodyapplication/jsonrequired

user_idinteger

Unique identifier of the attendee. Required when updating an existing attendee record. Set to 0 or omit when creating a new attendee.

Example: 0

emailstringrequired

Email address of the attendee. Must be unique within the event.

Example: "sample+seeker@vfairs.com"

first_namestringrequired

First name of the attendee.

Example: "Sample"

last_namestringrequired

Last name of the attendee.

Example: "Seeker"

statusintegerrequired

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

Example: 1

child_usersArray of strings

Array of child attendee objects for group registrations. Each object should contain the same fields as the parent attendee. Use form field slug values from the registration fields endpoint as keys.

Example: []

curl -i -X POST \
  https://developers.vfairs.com/_mock/apis/v5/users/attendees \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": 0,
    "email": "sample+seeker@vfairs.com",
    "first_name": "Sample",
    "last_name": "Seeker",
    "status": 1,
    "child_users": []
  }'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "Attendee(s) created successfully."

usersArray of objects

Example: [{"id":1237423116,"original_id":1237423116,"username":"alice.smith@example.com","first_name":"Alice","last_name":"Smith","type":8,"external_id":null,"qr_url":null,"resume":null,"registered_at":"2025-07-18T19:56:20.000000Z","has_paid":false,"is_active":true,"is_checked_in":false,"is_badge_printed":false,"email":"alice.smith@example.com","job_title":"Product Manager","company":"TechCorp","country":"USA","is_group_registration":true,"is_parent_user":false,"parent_user":{"id":1237423114,"email":"sam.van.hauwaert@secureics.be"}}]

Response

application/json

{
  "status": true,
  "message": "Attendee(s) created successfully.",
  "users": [
    { … }
  ]
}

Get Attendees

Request

Retrieves a paginated list of event attendees with optional filtering and sorting capabilities.

Security

BearerToken

Query

pageinteger

Page number for pagination.

Example: page=1

limitinteger

Number of records to return per page (max 100).

Example: limit=50

is_activeboolean

Filter by attendee status. If true, returns active attendees; if false, returns inactive attendees.

Example: is_active=true

emailstring

Filter by specific email address to retrieve a single attendee.

Example: email=dyzyrupesu@mailinator.com

user_idinteger

Filter by specific user ID to retrieve a single attendee.

Example: user_id=630706019

magic_login_linkboolean

Include magic login link in response. If true, generates a passwordless login URL for the attendee.

Example: magic_login_link=true

payment_detailsboolean

Include payment information in response. If true, returns payment status and transaction details.

Example: payment_details=true

order_by_updated_recordboolean

Sort by last updated date. If true, applies descending sort on updated_at field.

Example: order_by_updated_record=true

start_datestring

Start date for filtering attendees. Uses registered_at when order_by_updated_record=false, otherwise uses updated_at. Format: YYYY-MM-DD.

Example: start_date=2024-11-01

end_datestring

End date for filtering attendees. Uses registered_at when order_by_updated_record=false, otherwise uses updated_at. Format: YYYY-MM-DD.

Example: end_date=2024-11-10

curl -i -X GET \
  'https://developers.vfairs.com/_mock/apis/v5/users/attendees?page=1&limit=50&is_active=true&email=dyzyrupesu%40mailinator.com&user_id=630706019&magic_login_link=true&payment_details=true&order_by_updated_record=true&start_date=2024-11-01&end_date=2024-11-10' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "Successful retrieval of attendees."

usersArray of objects

Example: [{"id":1234995257,"original_id":1234995257,"username":"sam.van.hauwaert@secureics.be","first_name":"Sam","last_name":"Van Hauwaert","type":8,"external_id":null,"qr_url":"https://vfairs-api.s3.amazonaws.com/user-qr-codes/vfairs_qr17374721581080332676.jpg","resume":null,"registered_at":"2025-01-21T15:09:17.000000Z","has_paid":false,"is_active":true}]

metaobject

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

Response

application/json

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

User Segments

Manages user segments for the current event. User segments are used to target specific groups of users for marketing and communication purposes.

Operations

User Segment Rules

Manages user segment rules for the current event. User segment rules define criteria-based targeting for specific groups of users.

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 Representatives

Manages booth representatives who interact with visitors in virtual exhibition booths. Representatives can be assigned to multiple booths and have specific roles and permissions.

Operations

Booth Job Vacancies

Manages job vacancies within exhibition booths where exhibitors can post job openings, manage applications, and showcase career opportunities to event attendees.

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

OAuth Access Token

Attendees

Get Attendee Form Fields

Request

Responses

Was this helpful?

Create/Update Attendee

Request

Responses

Was this helpful?

Get Attendees

Request

Responses

Was this helpful?

User Segments

User Segment Rules

Session Tracks

Sessions

Session Handouts

Speakers

Booths

Booth Representatives

Booth Job Vacancies

Booth Documents

Booth Videos

Floors

Event

Reports