Skip to content
This repository was archived by the owner on Feb 4, 2026. It is now read-only.

Getting Started with the RESTful API

Jesse Snipper edited this page Apr 29, 2016 · 3 revisions

The RESTful API provides a way to retrieve data from GoExpo for use in external applications.

Available Operations

All of the examples in the list of available operations use the sandbox demo site here: https://n1a.goexposoftware.com/events/sbd. Additional documentation for the operations, parameters, etc. can be found in the Swagger documentation here: https://swagger.goexposoftware.com/?url=https://n1a.goexposoftware.com/events/sbd/goExpo/api/public/v1/swagger.json.

Get All Exhibitors - /api/public/v1/exhibitor

This operation can be used to retrieve a list of exhibitors from GoExpo. Searching/filtering is supported by adding variables to the search URL (e.g. /api/public/v1/exhibitor?id=2). The list of available search parameters can be found by using the "Get Exhibitor Parameters" API call.

Example

In this example, you are shown how to get all of the exhibitors in the system and formulate a table based on the data that was received.

Live Demo

http://core-apps.github.io/goexpo-api/examples/getExhibitors.html (Note: it may take a few seconds to load)

Get One Exhibitor - /api/public/v1/exhibitor/{id}

This operation can be used to retrieve data about one single exhibitor from GoExpo by adding the exhibitor’s ID to the end of the URL.

Example

In this example, you are shown how to get data on a single exhibitor from the API and display it in the DOM. You could also achieve the same functionality by filtering on the "Get All Exhibitors" API call (e.g. /api/public/v1/exhibitor?id=2).

Get Exhibitor Parameters - /api/public/v1/exhibitor/parameters

This operation can be used to determine the available search parameters for a "Get All Exhibitors" API call. The result will contain the list of parameters along with the type of field that should be used and any constraints that exist on the field (e.g. minimum length, maximum length, etc.).

Example

In this example, we’re shown how to get the available search fields by using the "Get Exhibitor Parameters" API call. Those search fields are then used to populate a list of exhibitors based on ID, name, email address, keyword, and a custom field using the "Get All Exhibitors" API call. One of the benefits of building your own search functionality using the API is having the freedom to search on many fields using a single search box. In the example shown, we combine "Company Name", "Keyword", and a custom field into a single search box and then use the value to search on all three attributes using the "Get All Exhibitors" API call.

Get All Seminars - /api/public/v1/seminar

This operation can be used to retrieve a list of seminars from GoExpo. Searching/filtering is supported by adding variables to the search URL (e.g. /api/public/v1/seminar?id=38). The list of available search parameters can be found by using the "Get Seminar Parameters" API call.

Example

In this example, you are shown how to get all of the seminars in the system and formulate a table based on the data that was received.

Get One Seminar - /api/public/v1/seminar/{id}

This operation can be used to retrieve data about one single seminar from GoExpo by adding the seminar’s ID to the end of the URL.

Example

In this example, you are shown how to get data on a single seminar from the API and display it in the DOM. You could also achieve the same functionality by filtering on the "Get All Seminars" API call (e.g. /api/public/v1/seminar?id=38).

Get Seminar Parameters - /api/public/v1/seminar/parameters

This operation can be used to determine the available search parameters for a "Get All Seminars" API call. The result will contain the list of parameters along with the type of field that should be used and any constraints that exist on the field (e.g. minimum length, maximum length, etc.).

Example

In this example, we’re shown how to get the available search fields by using the "Get Seminar Parameters" API call. Those search fields are then used to populate a list of seminars based on ID, name, and track using the "Get All Seminars" API call.

Get All Speakers - /api/public/v1/speaker

This operation can be used to retrieve a list of speakers from GoExpo. Searching/filtering is supported by adding variables to the search URL (e.g. /api/public/v1/speaker?id=26). The list of available search parameters can be found by using the "Get Speaker Parameters" API call.

Example

In this example, you are shown how to get all of the speakers in the system and formulate a table based on the data that was received.

Get One Speaker - /api/public/v1/speaker/{id}

This operation can be used to retrieve data about one single speaker from GoExpo by adding the speaker’s ID to the end of the URL.

Example

In this example, you are shown how to get data on a single speaker from the API and display it in the DOM. You could also achieve the same functionality by filtering on the "Get All Speakers" API call (e.g. /api/public/v1/speaker?id=26).

Get Speaker Parameters - /api/public/v1/speaker/parameters

This operation can be used to determine the available search parameters for a "Get All Speakers" API call. The result will contain the list of parameters along with the type of field that should be used and any constraints that exist on the field (e.g. minimum length, maximum length, etc.).

Example

In this example, we’re shown how to get the available search fields by using the "Get Speaker Parameters" API call. Those search fields are then used to populate a list of speakers based on ID, name, and company name using the "Get All Speakers" API call.

Clone this wiki locally