Create or Update Booth

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

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

Get Booths

Request

Retrieves a paginated list of exhibition booths with optional filtering capabilities.

Security

default

Query

pageinteger

Page number for pagination results.

Example: page=1

limitinteger

Number of booth records to return per page (default: 10).

Example: limit=10

floor_idinteger

Unique identifier of the floor to filter booths. Must correspond to an existing floor within the event.

Example: floor_id=1

booth_idinteger

Unique identifier of a specific booth to retrieve.

Example: booth_id=123

activeboolean

Filter booths by active status. When true, returns only active booths; when false, returns only inactive booths.

Example: active=true

curl -i -X GET \
  'https://api.vfairs.com/rest/v5/booths?active=true&booth_id=123&floor_id=1&limit=10&page=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "Booths fetched successfully."

boothsArray of objects

Example: [{"booth_id":292638,"booth_name":"Booth B","booth_company_profile":"Test Description","booth_company_url":"","booth_type":"Both","keywords":"","booth_external_id":null,"active":1,"hide":0,"floor_id":16990,"address":"","country":null,"state":"","city":"","pobox":"","booth_setup_url":"https://demo.vfairs.com/backend/index.php/booths/setup/292638","booth_images":{"booth_logo_url":"https://vepimg.b8cdn.com/uploads/uploads/vjfnew/15032/content/images/1741726352coming-soon-png1741726352.png","booth_logo_url_thumbnail":"https://vepimg.b8cdn.com/contents/showcase/logo/1220193418s-logo.png","booth_large_background_url":"https://vepimg.b8cdn.com/uploads/vjfnew/15032/content/images/1741726446coming-soon-png1741726446.png"},"contacts":[],"booth_reps":[]}]

metaobject

Example: {"current_page":1,"from":1,"last_page":11,"path":"http://demo.vfairs.com/rest/v5/booths","per_page":1,"to":1,"total":11}

Response

application/json

{
  "status": true,
  "message": "Booths fetched successfully.",
  "booths": [
    { … }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 11,
    "path": "http://demo.vfairs.com/rest/v5/booths",
    "per_page": 1,
    "to": 1,
    "total": 11
  }
}

Create or Update Booth

Request

Creates a new booth or updates an existing booth based on whether booth_id is provided.

Security

default

Bodymultipart/form-datarequired

booth_idinteger

Unique identifier of the booth. Required when updating an existing booth; omit when creating a new booth.

Example: 292638

booth_namestringrequired

Display name of the booth as shown to visitors.

Example: "Tech Innovation Showcase"

booth_company_profilestringrequired

Company description and profile information displayed in the booth.

Example: "Leading technology company specializing in AI solutions"

booth_company_urlstringrequired

Company website URL for external links from the booth.

Example: "https://techcompany.com"

addressstringrequired

Physical address of the company or booth location.

Example: "123 Innovation Drive"

poboxstringrequired

Postal box number for company correspondence.

Example: "PO Box 456"

citystringrequired

City where the company is located.

Example: "San Francisco"

statestringrequired

State or province where the company is located.

Example: "California"

countrystringrequired

Country where the company is located.

Example: "United States"

exhibitor_namestringrequired

Full name of the primary exhibitor or booth contact person.

Example: "John Smith"

exhibitor_emailstringrequired

Email address of the primary exhibitor for booth-related communications.

Example: "john.smith@techcompany.com"

booth_typestring

Type of booth interface. Determines how the booth is displayed and accessed.

Enum"web""mobile""both"

Example: "web"

keywordsstringrequired

Comma-separated keywords for booth search and categorization.

Example: "technology, AI, innovation, software"

booth_external_idinteger

External system identifier for booth integration purposes.

Example: 789

activebooleanrequired

Booth visibility status. When true, booth is visible to visitors; when false, booth is hidden.

Example: true

hidebooleanrequired

Additional visibility control. When true, booth is completely hidden from all listings.

Example: false

floor_idintegerrequired

Unique identifier of the floor where this booth is located. Must correspond to an existing floor within the event.

Example: 16990

booth_logostring(binary)required

Company logo image file for the booth (JPG, PNG formats supported).

booth_thumbnailstring(binary)

Thumbnail image for booth preview in listings (JPG, PNG formats supported).

booth_backgroundstring(binary)required

Background image for the booth display (JPG, PNG formats supported).

accessible_forArray of strings

Array of accessibility options defining who can access this booth.

Example: ["Physical","Virtual"]

booth_rep_idsArray of strings

Array of booth representative IDs to associate with this booth. Representatives must exist in the system.

Example: [101,102,103]

curl -i -X POST \
  https://api.vfairs.com/rest/v5/booths \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F booth_id=292638 \
  -F 'booth_name=Tech Innovation Showcase' \
  -F 'booth_company_profile=Leading technology company specializing in AI solutions' \
  -F booth_company_url=https://techcompany.com \
  -F 'address=123 Innovation Drive' \
  -F 'pobox=PO Box 456' \
  -F 'city=San Francisco' \
  -F state=California \
  -F 'country=United States' \
  -F 'exhibitor_name=John Smith' \
  -F exhibitor_email=john.smith@techcompany.com \
  -F booth_type=web \
  -F 'keywords=technology, AI, innovation, software' \
  -F booth_external_id=789 \
  -F active=true \
  -F hide=false \
  -F floor_id=16990 \
  -F booth_logo=string \
  -F booth_thumbnail=string \
  -F booth_background=string \
  -F accessible_for=Physical \
  -F accessible_for=Virtual \
  -F 'booth_rep_ids[0]=101' \
  -F 'booth_rep_ids[1]=102' \
  -F 'booth_rep_ids[2]=103'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "Booth created successfully."

booth_idinteger

Example: 292638

Response

application/json

{
  "status": true,
  "message": "Booth created successfully.",
  "booth_id": 292638
}

Delete Booth

Request

Permanently removes a booth and optionally its associated representatives.

Security

default

Bodyapplication/jsonrequired

booth_idintegerrequired

Unique identifier of the booth to delete. Must correspond to an existing booth.

Example: 292638

delete_repsbooleanrequired

Whether to also delete associated booth representatives. When true, removes all representatives; when false, keeps representatives for potential reassignment.

Example: true

curl -i -X DELETE \
  https://api.vfairs.com/rest/v5/booths \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "booth_id": 292638,
    "delete_reps": true
  }'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "Booth deleted successfully."

booth_idinteger

Example: 292638

Response

application/json

{
  "status": true,
  "message": "Booth deleted successfully.",
  "booth_id": 292638
}

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

Booths

Get Booths

Request

Responses

Was this helpful?

Create or Update Booth

Request

Responses

Was this helpful?

Delete Booth

Request

Responses

Was this helpful?

Booth Documents

Booth Videos

Floors

Event

Reports