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}/delete | 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 | Remove a speaker profile |
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 |
POST | {{server}}/v5/sessions | Create or update a session |
GET | {{server}}/v5/sessions | Retrieve all sessions |
DELETE | {{server}}/v5/sessions/{id} | Delete a session |
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 |
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/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 |
https://api.vfairs.com/rest/
https://api.vfairs.ca/rest/
https://api-eu.vfairs.com/rest/
https://api-uk.vfairs.com/rest/
https://api-ksa.vfairs.com/rest/
Unique identifier of the handout. Use 0 or omit for creating new handouts.
Unique identifier of the session. Must correspond to an existing session. See /v5/sessions
for valid session IDs.
File path or URL for the handout document. Accepted formats: PDF and DOCX.
- US
https://api.vfairs.com/rest/v5/sessions/sessionHandouts
- CA
https://api.vfairs.ca/rest/v5/sessions/sessionHandouts
- EU
https://api-eu.vfairs.com/rest/v5/sessions/sessionHandouts
- UK
https://api-uk.vfairs.com/rest/v5/sessions/sessionHandouts
- KSA
https://api-ksa.vfairs.com/rest/v5/sessions/sessionHandouts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.vfairs.com/rest/v5/sessions/sessionHandouts \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"handout_id": 0,
"session_id": 2171860,
"handout_link": "path/to/file/resume.pdf",
"handout_title": "Handout Title"
}'
{ "status": true, "message": "Session Handout(s) created successfully.", "handout_id": 12345 }
- US
https://api.vfairs.com/rest/v5/sessions/sessionHandouts
- CA
https://api.vfairs.ca/rest/v5/sessions/sessionHandouts
- EU
https://api-eu.vfairs.com/rest/v5/sessions/sessionHandouts
- UK
https://api-uk.vfairs.com/rest/v5/sessions/sessionHandouts
- KSA
https://api-ksa.vfairs.com/rest/v5/sessions/sessionHandouts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.vfairs.com/rest/v5/sessions/sessionHandouts?page=1&limit=12&session_id=2178341&handout_id=17806' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "status": true, "message": "Successful retrieval of session handouts.", "session_handouts": [ { … } ] }
- US
https://api.vfairs.com/rest/v5/sessions/sessionHandouts/{id}
- CA
https://api.vfairs.ca/rest/v5/sessions/sessionHandouts/{id}
- EU
https://api-eu.vfairs.com/rest/v5/sessions/sessionHandouts/{id}
- UK
https://api-uk.vfairs.com/rest/v5/sessions/sessionHandouts/{id}
- KSA
https://api-ksa.vfairs.com/rest/v5/sessions/sessionHandouts/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://api.vfairs.com/rest/v5/sessions/sessionHandouts/omnis \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "status": true, "message": "Session Handout deleted successfully.", "handout_id": 17806 }
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.