User Segments
/
Create/Update User Segment

API Documentation

MethodEndpointDescription
POST/v5/oauth/tokenGenerate an OAuth access token
POST/v5/users/attendeesCreate or update an attendee
GET/v5/users/attendeesRetrieve all attendees
POST/v5/users/attendees/{attendeeId}/resumeUpload an attendee's resume
DELETE/v5/users/attendees/{attendeeId}/deleteRemove an attendee
POST/v5/users/speakersCreate or update a speaker profile
GET/v5/users/speakersRetrieve all speakers
DELETE/v5/users/speakersRemove a speaker profile
POST/v5/users/boothRepsCreate or update a booth representative
GET/v5/users/boothRepsRetrieve all booth representatives
DELETE/v5/users/boothReps/{boothRepId}Remove a booth representative
POST/v5/users/segmentsCreate or update a segment
GET/v5/users/segmentsRetrieve all segments
DELETE/v5/users/segments/{segmentId}Remove a segment
POST/v5/users/segments/rulesCreate or update a segment rule
GET/v5/users/segments/rulesRetrieve all segment rules
DELETE/v5/users/segments/rules/{ruleId}Remove a segment rule
GET/v5/forms/attendeeFieldsRetrieve attendee form fields
GET/v5/forms/speakerFieldsRetrieve speaker form fields
GET/v5/forms/boothRepFieldsRetrieve booth representative form fields
POST/v5/sessionsCreate or update a session
GET/v5/sessionsRetrieve all sessions
DELETE/v5/sessions/{id}Delete a session
POST/v5/sessions/sessionTracksCreate or update a session track
GET/v5/sessions/sessionTracksRetrieve all session tracks
DELETE/v5/sessions/sessionTracks/{id}Delete a session track
POST/v5/sessions/sessionHandoutsUpload or update a session handout
GET/v5/sessions/sessionHandoutsRetrieve all session handouts
DELETE/v5/sessions/sessionHandouts/{id}Remove a session handout
POST/v5/boothsCreate or update a booth
GET/v5/boothsRetrieve all booths
DELETE/v5/boothsRemove a booth and optionally its representatives
POST/v5/booths/documentsCreate or update a booth document
GET/v5/booths/documentsRetrieve all booth documents
DELETE/v5/booths/documents/{documentId}Remove a booth document
POST/v5/booths/videosCreate or update a booth video
GET/v5/booths/videosRetrieve all booth videos
DELETE/v5/booths/videos/{videoId}Remove a booth video
POST/v5/floorsCreate or update a floor
GET/v5/floorsRetrieve all floors
DELETE/v5/floors/{floorId}Remove a floor and all its associated booths
GET/v5/event/languagesRetrieve available event languages
GET/v5/event/getEventDetailsGet detailed event information
GET/v5/reports/qrScanAnalyticsRetrieve QR scan analytics
GET/v5/reports/userJourneyAnalyticsRetrieve user journey analytics
Download OpenAPI description
Download Postman
Download OpenApi
Overview
Integrations

integrations@vfairs.com

Languages
Servers
US

https://api.vfairs.com/rest/

CA

https://api.vfairs.ca/rest/

EU

https://api-eu.vfairs.com/rest/

UK

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

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

Create/Update User Segment

Request

Creates a new user segment or updates an existing segment. The criteria_type determines which additional fields are required.

Security
BearerToken
Bodyapplication/jsonrequired
segment_idinteger or null

Unique identifier of an existing user segment to update. Leave empty when creating a new segment.

Example: 123
titlestringrequired

Name of the user segment. Must be unique and descriptive. Must not be greater than 255 characters.

Example: "VIP Attendees"
audiencestringrequired

Type of users to segment. Audience should be one of the following values: attendee, exhibitor, speaker.

Enum"attendee""exhibitor""speaker"
Example: "attendee"
criteria_typestringrequired

Method used to define segment criteria. Criteria type should be one of the following values: individual_attendees, registration_conditions, session_reservation.

Enum"individual_attendees""registration_conditions""session_reservation"
Example: "individual_attendees"
user_idsArray of integersrequired

Individual user ID. Must correspond to an existing user of the specified audience type.

Example: [1]
registration_criteriaobject or null

Complex criteria for filtering users based on registration data. Required only when criteria_type is "registration_conditions".

Example: null
session_conditionobject or null

Criteria for filtering users based on session reservations. Required only when criteria_type is "session_reservation" and audience is "attendee".

Example: null
curl -i -X POST \
  https://api.vfairs.com/rest/v5/users/segments \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "segment_id": 123,
    "title": "VIP Attendees",
    "audience": "attendee",
    "criteria_type": "individual_attendees",
    "user_ids": [
      1
    ],
    "registration_criteria": null,
    "session_condition": null
  }'

Responses

Bodyapplication/json
statusboolean
Example: true
messagestring
Example: "User segment created successfully."
dataobject
Example: {"segment_id":123}
Response
application/json
{
  "status": true,
  "message": "User segment created successfully.",
  "data": {
    "segment_id": 123
  }
}

Get User Segments

Request

Retrieves a paginated list of user segments for the current event with optional filtering.

Security
BearerToken
Query
pageinteger

Page number for pagination. Defaults to 1 if not provided.

Example: page=1
limitinteger

Number of user segments to return per page. Defaults to 20 if not provided.

Example: limit=20
segment_idinteger

Unique identifier of the user segment to filter by. Must correspond to an existing segment within the current event.

Example: segment_id=123
audiencestring

Filter segments by audience type. Valid values: attendee, exhibitor, speaker.

Example: audience=attendee
criteria_typestring

Filter segments by criteria type. Valid values: individual_attendees, registration_conditions, session_reservation.

Example: criteria_type=registration_conditions
curl -i -X GET \
  'https://api.vfairs.com/rest/v5/users/segments?audience=attendee&criteria_type=registration_conditions&limit=20&page=1&segment_id=123' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
statusboolean
Example: true
messagestring
Example: "User Segment(s) fetched successfully."
user_segmentsArray of objects
Example: [{"id":6600,"app_id":15032,"name":"User Segment","audience":"Attendee","criteria_type":"individual_attendees","user_ids":[1236996313],"registration_criteria":null,"session_criteria":null},{"id":6601,"app_id":15032,"name":"User Segment","audience":"Attendee","criteria_type":"registration_conditions","user_ids":null,"registration_criteria":{"form_conditions":[{"registration_field_id":1496299,"condition":"contains","value":"213"}],"logged_in_status":"logged_in_at_least_once","account_status":"both","registration_date_start":"2025-01-01 00:00:00","registration_date_end":"2025-12-12 00:00:00"},"session_criteria":null},{"id":6623,"app_id":15032,"name":"User Segment","audience":"Attendee","criteria_type":"session_reservation","user_ids":null,"registration_criteria":null,"session_criteria":{"session":{"id":2639065,"title":null,"type":"Webinar"},"is_reserved":"is_reserved"}}]
metaobject
Example: {"current_page":1,"from":1,"last_page":1,"path":"https://api.vfairs.com/rest/v5/users/segments","per_page":20,"to":20,"total":20}
Response
application/json
{
  "status": true,
  "message": "User Segment(s) fetched successfully.",
  "user_segments": [
    { … },
    { … },
    { … }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.vfairs.com/rest/v5/users/segments",
    "per_page": 20,
    "to": 20,
    "total": 20
  }
}

Delete User Segment

Request

Permanently removes a user segment and all associated data.

Security
BearerToken
Path
segmentIdintegerrequired

Unique identifier of the user segment to delete. Must correspond to an existing segment within the current event.

Example: 123
curl -i -X DELETE \
  https://api.vfairs.com/rest/v5/users/segments/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
statusboolean
Example: true
messagestring
Example: "User segment deleted successfully."
segment_idinteger
Example: 123
Response
application/json
{
  "status": true,
  "message": "User segment deleted successfully.",
  "segment_id": 123
}

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 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
Copyright © 2025 vFairs