Get Attendees

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

Create/Update Attendee

Request

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

Security

default

Bodyapplication/jsonrequired

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://api.vfairs.com/rest/v5/users/attendees \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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."

dataobject

Example: {"id":12214213,"external_id":123213}

Response

application/json

{
  "status": true,
  "message": "Attendee(s) created successfully.",
  "data": {
    "id": 12214213,
    "external_id": 123213
  }
}

Get Attendees

Request

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

Security

default

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://api.vfairs.com/rest/v5/users/attendees?email=dyzyrupesu%40mailinator.com&end_date=2024-11-10&is_active=true&limit=50&magic_login_link=true&order_by_updated_record=true&page=1&payment_details=true&start_date=2024-11-01&user_id=630706019' \
  -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
  }
}

Upload Attendee Resume

Request

Uploads a resume file for a specific attendee.

Security

default

Path

attendeeIdintegerrequired

Unique identifier of the attendee. Must correspond to an existing attendee record.

Example: 123123

Bodymultipart/form-datarequired

resumestring(binary)required

The resume file to be uploaded. Accepted file formats: PDF and DOCX. Must be a file. Must not be greater than 5120 kilobytes.

curl -i -X POST \
  https://api.vfairs.com/rest/v5/users/attendees/123123/resume \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F resume=string

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "successfully, Resume uploaded."

resumestring

Example: "https://example.com/uploads/resume_001.pdf"

Response

application/json

{
  "status": true,
  "message": "successfully, Resume uploaded.",
  "resume": "https://example.com/uploads/resume_001.pdf"
}

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

Create/Update Attendee

Request

Responses

Was this helpful?

Get Attendees

Request

Responses

Was this helpful?

Upload Attendee Resume

Request

Responses

Was this helpful?

Session Tracks

Sessions

Session Handouts

Speakers

Booths

Booth Documents

Booth Videos

Floors

Event

Reports