API Reference

Get Summary of All Exhibitors

This API returns the summary details of exhibitors - showing data in display and portal side from the event URL.

Response

Here is the description of response attributes, which returns to the form of JSON.

AttributeDescription
recordsTotal Contains the total number of records found.
recordsFiltered Contains the total number of records to be fetched.
id Contains the unique ID of the exhibitor.
eventId Contains a unique ID of the event.
exhibitorName Contains the full name of the exhibitor.
boothSize Contains the booth size - SMALL, MEDIUM, LARGE. This setting can only be updated by the event host.
categoryId Contains the ID of the exhibitor category.
showStatusIndicator Returns if the "Show status indicator" on expo page is enabled.
preferredExhibitor Shows whether a booth is preferred exhibitor. This setting can only be updated by event host.
chatEnabledShows if the chat is enabled for the exhibitor booth.
categoryName Contains the name of the exhibitor category.
position Contains the position of the exhibitor booth.
colorConfig Contains the exhibitor name and short description color.
linkToSite Contains a comma-separated link to the exhibitor website.
showBoothName Shows if "Show Booth Name" is enabled.
featured Shows whether the exhibitor is a featured booth.
categoryPositionJson Contains the exhibitors category position details.
error Contains any error description.
numberOfExhibitorsRemainingToEnable Contains total number of exhibitors remaining to be enabled.
numberOfProExhibitorPurchased Contains the total number of Pro exhibitor(s).

Error Code

Here are the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error CodeError Description
400The request could not be understood by the server due to malformed syntax.
401You are not authorized to view the resource
403Accessing the resource you were trying to reach is forbidden
404The resource you were trying to reach is not found
40600013Cannot create url
4040200Event Not Found
Language
Credentials
Header
Click Try It! to start a request and see the response here!