DOCS

Appearance

Events ​

Get Filtered Events ​

Paged method used for exploring and searching for available events.

Method ​

GET

Request Path Authorized ​

/api/Events/GetFilteredEvents?

Query String Parameters ​

http
searchField:
searchCriteria:
pageSize:20
pageIndex:0
startDate:
endDate:
orderByField:"eventDate"
ascending:false

NOTE

Times are UTC+0 and to be formatted as yyyy-MM-ddThh:mm:ss.fffZ

Headers ​

http
tenantId: <tenant-id>
applicationId: <application-id>

Response ​

Note that not all fields are included in the sample response, only those relevant to these docs

json
{
    "items": [
        {
            "canEdit": false,        
            "eventId": "<event-id>",
            "parentEventId": null,
            "eventReference": "A5898X",
            "eventActive": true,                        
            "name": "Event Name",
            "eventDate": "Listing date time",            
            "tenantId": "<tenant-id>",                        
            ...
        }
        ...
    ],
    "totalDataCount": 100,
    "hasContent": true
}

NOTE

Times are UTC+0 and to be formatted as yyyy-MM-ddThh:mm:ss.fffZ