/v1/volunteer/events/search

This endpoint allows you to search all the volunteer events in the client community. It returns a paginated set of results with all the event details. In the body of the post, you will pass the following:



The term is the string that the API will use to search for matching event names.



The page is the page of results you wish to fetch.



The pageSize is number of results per page. This cannot exceed 25 and will default to 25 if the value you pass is greater.



startDate defines the start date of the date range you are searching within.



endDate defines the end date of the date range you are searching within.



If includeVirtual is true, all Virtual Events (events with no location) will be included. The default value is false.



To search by location, you can use the optional distanceInMiles, latitude, and longitude params. By passing a lat and long, your result set will contain events within a 50 mile radius of the location. If you wish to change the search radius, use the distanceInMiles param to define a different search radius.



If hideFull is true, all events with a set capacity and no open shifts will be excluded.



Note: In the return, eventType identifies the type of event. If the value is 1, the event was created by someone at the company. If the value is 2 the event was created externally by a non-profit. Also, this is not related to EventTypes (plural) which includes a set of meta data tag "Types" that are used for reporting and search filtering. These are defined by the event creator while creating the event.



Language