Get All Exhibitors
The Get All Exhibitors API allows event organizers and portal administrators to retrieve a complete list of exhibitors associated with a specific event within their Zoho Backstage portal. This endpoint is primarily used to fetch company details, booth assignments, contact information, financial data, company descriptions, and social media handles for all exhibitors participating in an event. This helps organizers keep track of all participating companies, manage booth arrangements, and ensure up-to-date exhibitor listings for attendees.
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
OAuth Scope
zohobackstage.exhibitor.READ
Path Parameters
- portal_id (Integer)
The unique identifier of your Zoho Backstage portal. This tells the system from which portal to retrieve the exhibitor list. For example, "portal_id": 19593237 specifies that the list will be retrieved from portal ID 19593237. - event_id (Integer)
The unique identifier of the event for which you want to fetch the exhibitor list. For example, "event_id": 2000000345678 indicates that all exhibitors participating in this specific event will be retrieved.
Response Structure and Field Explanations
A successful API call returns a JSON response with an array of all exhibitors linked to the specified event. Each exhibitor object contains detailed company information, financial data, booth details, contact information, and metadata about when and by whom the record was created or last updated. The response also includes pagination details to help you navigate large datasets efficiently.
- exhibitors (Array)
An array containing the list of all exhibitors for the event. Each item in the array is an exhibitor object.- booth_id (String)
The system-generated ID of the booth assigned to the exhibitor. This helps event organizers and attendees locate the exhibitor during the event. For example, "booth_id": "2000000013071" indicates the assigned booth. - company_name (String)
The full name of the exhibitor’s organization. This appears on the event website and promotional materials. For example, "company_name": "Zoho Corporation" shows the exhibitor’s company name. - company_overview (String)
A detailed description of the exhibitor’s company, which may include its mission, services, and background. For example, "company_overview": "Zoho is a global technology company providing a suite of cloud-based productivity tools." gives attendees insight into the exhibitor. - amount (Integer)
The total amount billed or paid by the exhibitor, covering booth fees, sponsorships, or other services. For example, "amount": 500 indicates the total fee paid. - currency_code (String)
The three-letter ISO currency code for the billed amount. For example, "currency_code": "USD" shows that the exhibitor is billed in US Dollars. - company_short_description (String)
A concise version of the company description suitable for quick listings or spaces with limited display area. For example, "company_short_description": "Leading global provider of cloud software." gives a brief summary. - company_social_pages (Object)
An object containing links to the exhibitor’s social media profiles for better visibility and networking.- facebook (String)
The URL to the exhibitor’s official Facebook page. For example, "facebook": "https://www.facebook.com/zoho" shows Zoho Corporation’s Facebook page.
- facebook (String)
- contact (Object)
A nested object containing the primary contact person’s details for the exhibitor. This information is used for all communication related to the event.- email (String)
The official email address for the contact person, used for event correspondence and updates. For example, "email": "john.doe@zoho.com" is the contact’s email. - first_name (String)
The first name of the exhibitor’s main contact person. For example, "first_name": "John" specifies the contact’s first name. - last_name (String)
The last name of the exhibitor’s contact person. For example, "last_name": "Doe" specifies the contact’s surname. - mobile_no (String)
The mobile number of the contact person for direct calls or urgent updates. For example, "mobile_no": "9876543210" is the contact’s mobile number.
- email (String)
- created_by (Object)
Details of the user who originally created the exhibitor record. This helps maintain a clear audit trail.- id (String)
The unique ID of the user who created the entry. For example, "id": "2000000000001" identifies the creator. - email (String)
The email address of the user who created the exhibitor record. For example, "email": "john.doe@zoho.com" is the creator’s email. - first_name (String)
The display name or first name of the creator. For example, "first_name": "John" shows the creator’s name. - company (String)
The company associated with the user who created the record. May be null if not specified. For example, "company": "Zoho Corporation" indicates the company or "company": null" shows no company was specified. - designation (String)
The job title or designation of the creator, if provided. May be null if not available. For example, "designation": "Event Manager" shows the creator’s role.
- id (String)
- created_time (String)
The timestamp when the exhibitor record was created, in ISO 8601 format in UTC. For example, "created_time": "2025-03-21T06:14:21Z" marks the record creation date and time. - last_modified_by (Object)
Details of the user who last updated the exhibitor record. This structure mirrors the created_by object.- id (String)
The ID of the user who last modified the record. For example, "id": "2000000000001" shows who made the most recent changes. - email (String)
The email address of the user who last modified the exhibitor record. For example, "email": "john.doe@zoho.com" shows the last modifier’s email. - first_name (String)
The display name or first name of the last modifying user. For example, "first_name": "John" indicates who updated the entry. - company (String or null)
The company associated with the user who last modified the record, if available. May be null if not specified. For example, "company": "Zoho Corporation" or "company": null". - designation (String or null)
The job title or designation of the last modifying user, if available. May be null if not set. For example, "designation": "Event Manager" or "designation": null".
- id (String)
- last_modified_time (String)
The timestamp when the exhibitor record was last modified, in ISO 8601 format in UTC. For example, "last_modified_time": "2025-03-21T06:14:21Z" marks the update date and time. - website_url (String)
The official website URL of the exhibitor’s company. Attendees can visit this link to learn more about the company’s products, services, or background. For example, "website_url": "https://www.zoho.com" shows the exhibitor’s live website address.
- booth_id (String)
- pagination (Object)
An object that provides pagination details when multiple exhibitors are retrieved. Use this information to handle large data sets and navigate through pages.- has_more_items (Boolean)
Indicates whether more pages of exhibitors are available. For example, "has_more_items": false means there are no more pages. - page (Integer)
The current page number in the pagination sequence. For example, "page": 1" specifies that this is the first page. - per_page (Integer)
The maximum number of exhibitors returned per page. For example, "per_page": 500" shows that up to 500 exhibitors can be retrieved in one page. - total_count (Integer)
The total number of exhibitors available for the event. For example, "total_count": 1" indicates that one exhibitor is available. - total_pages (Integer)
The total number of pages available for the current query. For example, "total_pages": 1" shows that there is only one page of results.
- has_more_items (Boolean)
URL
Copiedv3/portals/{portal_id}/events/{event_id}/exhibitorsExample
Copiedhttps://zohoapis.com/backstage/v3/portals/19593237/events/2000000345678/exhibitorsSample Response
Copied{
"exhibitors": [
{
"booth_id": "2000000013071",
"company_name": "Zoho Corporation",
"company_overview": "Zoho is a global technology company providing a suite of cloud-based productivity tools.",
"amount": 500,
"currency_code": "USD",
"company_short_description": "Leading global provider of cloud software.",
"company_social_pages": {
"facebook": "https://www.facebook.com/zoho"
},
"contact": {
"email": "john.doe@zoho.com",
"first_name": "John",
"last_name": "Doe",
"mobile_no": "9876543210"
},
"created_by": {
"company": "Zoho Corporation",
"designation": "Event Manager",
"email": "john.doe@zoho.com",
"first_name": "John",
"id": "2000000000001"
},
"created_time": "2025-03-21T06:14:21Z",
"id": "2000000020001",
"last_modified_by": {
"company": "Zoho Corporation",
"designation": "Event Manager",
"email": "john.doe@zoho.com",
"first_name": "John",
"id": "2000000000001"
},
"last_modified_time": "2025-03-21T06:14:21Z",
"website_url": "https://www.zoho.com"
}
],
"pagination": {
"has_more_items": false,
"page": 1,
"per_page": 500,
"total_count": 1,
"total_pages": 1
}
}