GET api/properties/{PropertyId}/events?startDate={startDate}&endDate={endDate}&calendarId={calendarId}&page={page}&pageSize={pageSize}

Get events by property Id.

Request Information

Authentication

This method requires user authentication

URI Parameters

Name	Description	Type	Additional information
PropertyId	(Required)If property id = 0 then all events linked to all the properties linked to the user will be returned	integer	Required
startDate	(Optional)If startDate is null then it will default to one week before the current month	date	None.
endDate	(Optional)If endDate is null then it will default to one week after the end of the current month	date	None.
calendarId	(Optional)Limits the results by Calendar Id. See the GET api/properties/{PropertyId}/calendars route to get a list of calendars for the property.	string
page	(Optional)The page number of returned records based on the page size	integer	0
pageSize	(Optional)The number of records to return per page	integer	0

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfEvent

Name	Description	Type	Additional information
Total		integer	None.
Elements		Collection of Event	None.

Response Formats

application/json, text/json

Sample:

{
  "Total": 1,
  "Elements": [
    {
      "EventId": 1,
      "PropertyId": 2,
      "CalEventTypeId": 1,
      "EventName": "sample string 3",
      "EventNotes": "sample string 4",
      "CalendarId": 5,
      "EventStartDtm": "2025-12-24T05:28:27.2803993-05:00",
      "EventEndDtm": "2025-12-24T05:28:27.2803993-05:00"
    },
    {
      "EventId": 1,
      "PropertyId": 2,
      "CalEventTypeId": 1,
      "EventName": "sample string 3",
      "EventNotes": "sample string 4",
      "CalendarId": 5,
      "EventStartDtm": "2025-12-24T05:28:27.2803993-05:00",
      "EventEndDtm": "2025-12-24T05:28:27.2803993-05:00"
    }
  ]
}

Internal Error Codes

106: ResourceNotFound
(The requested resource was not found., NotFound)
100: MissingRequiredHeader
(Invalid request format. A required HTTP header was not specified., BadRequest)
118: InvalidHeaderValue
(The value provided for one of the HTTP headers was not in the correct format., BadRequest)
199: UnknownError
(Internal server error., InternalServerError)
105: ResourceNotLinkedToUser
(User is trying to access a resource that belongs to a property not linked to the user., Forbidden)