POST api/v1.0/Events/SearchEvents?maxRecords={maxRecords}

Get Event details. The retrieved Events can be filtered by the values passed in the eventFilter parameter.

Request Information

URI Parameters

Name	Description	Type	Additional information
maxRecords	Specify the maximum number of records to return. Defaults to 100 if not specified.	integer	Default value is 100

Body Parameters

Allows filtering of the Events that are returned.

CalendarEventRequest

Name	Type	Additional information
StartDate	date	None.
EndDate	date	None.
EventTypeName	string	None.
CommunityKey	globally unique identifier	None.
SearchKeywords	string	None.

Request Formats

application/json, text/json

Sample:

{
  "StartDate": "2026-05-23T22:51:03.7542755Z",
  "EndDate": "2026-05-23T22:51:03.7542755Z",
  "EventTypeName": "sample string 3",
  "CommunityKey": "0e262a82-9e2e-4164-ab01-89ce3ed9f250",
  "SearchKeywords": "sample string 5"
}

application/xml, text/xml

Sample:

<CalendarEventRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request">
  <CommunityKey>0e262a82-9e2e-4164-ab01-89ce3ed9f250</CommunityKey>
  <EndDate>2026-05-23T18:51:03.7542755-04:00</EndDate>
  <EventTypeName>sample string 3</EventTypeName>
  <SearchKeywords>sample string 5</SearchKeywords>
  <StartDate>2026-05-23T18:51:03.7542755-04:00</StartDate>
</CalendarEventRequest>

Response Information

Resource Description

List of Events.

Collection of Event

Name	Type	Additional information
RegistrationOptions	Collection of EventOption	None.
Sessions	Collection of EventSession	None.
EventKey	globally unique identifier	None.
Address		None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.