GET api/users/{userId}/calendar/events?startDate={startDate}&endDate={endDate}

This method will retrieve a collection of calendar events for a user based on the specified date range or for a specific date. Specific date is set only when day parameter is specified on request; otherwise a first and last days of a month identified in the request will be taken

Request Information

URI Parameters

Name	Description	Type	Additional information
userId	User id	integer	Required
startDate		string	Required
endDate		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of

Collection of CalendarEventResponseModel

Name	Type	Additional information
Title	string	None.
StartDate	string	None.
EndDate	string	None.
StartTime	string	None.
EndTime	string	None.
CountyId	integer	None.
TownshipId	integer	None.
Notes	string	None.
IsPrivate	boolean	None.
IsSystemWide	boolean	None.
IsReoccuring	boolean	None.
EmployeeIds	Collection of integer	None.
AddedDate	date	None.
AgencyId	integer	None.
CalendarEventColor	string	None.
Interval	string	None.
Id	integer	None.
Location	string	None.
CountyName	string	None.
TownshipName	string	None.
AgencyName	string	None.
CalendarEventType	string	None.
UserId	integer	None.
CalendarEventTypeId	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "title": "sample string 1",
    "startDate": "sample string 2",
    "endDate": "sample string 3",
    "startTime": "sample string 4",
    "endTime": "sample string 5",
    "countyId": 1,
    "townshipId": 6,
    "notes": "sample string 7",
    "isPrivate": true,
    "isSystemWide": true,
    "isReoccuring": true,
    "employeeIds": [
      1,
      2
    ],
    "addedDate": "2025-05-20T14:41:40.3146781-05:00",
    "agencyId": 12,
    "calendarEventColor": "sample string 13",
    "interval": "sample string 14",
    "id": 15,
    "location": "sample string 16",
    "countyName": "sample string 17",
    "townshipName": "sample string 18",
    "agencyName": "sample string 19",
    "calendarEventType": "sample string 20",
    "userId": 21,
    "calendarEventTypeId": 22
  },
  {
    "title": "sample string 1",
    "startDate": "sample string 2",
    "endDate": "sample string 3",
    "startTime": "sample string 4",
    "endTime": "sample string 5",
    "countyId": 1,
    "townshipId": 6,
    "notes": "sample string 7",
    "isPrivate": true,
    "isSystemWide": true,
    "isReoccuring": true,
    "employeeIds": [
      1,
      2
    ],
    "addedDate": "2025-05-20T14:41:40.3146781-05:00",
    "agencyId": 12,
    "calendarEventColor": "sample string 13",
    "interval": "sample string 14",
    "id": 15,
    "location": "sample string 16",
    "countyName": "sample string 17",
    "townshipName": "sample string 18",
    "agencyName": "sample string 19",
    "calendarEventType": "sample string 20",
    "userId": 21,
    "calendarEventTypeId": 22
  }
]

text/html

Sample:

[{"title":"sample string 1","startDate":"sample string 2","endDate":"sample string 3","startTime":"sample string 4","endTime":"sample string 5","countyId":1,"townshipId":6,"notes":"sample string 7","isPrivate":true,"isSystemWide":true,"isReoccuring":true,"employeeIds":[1,2],"addedDate":"2025-05-20T14:41:40.3146781-05:00","agencyId":12,"calendarEventColor":"sample string 13","interval":"sample string 14","id":15,"location":"sample string 16","countyName":"sample string 17","townshipName":"sample string 18","agencyName":"sample string 19","calendarEventType":"sample string 20","userId":21,"calendarEventTypeId":22},{"title":"sample string 1","startDate":"sample string 2","endDate":"sample string 3","startTime":"sample string 4","endTime":"sample string 5","countyId":1,"townshipId":6,"notes":"sample string 7","isPrivate":true,"isSystemWide":true,"isReoccuring":true,"employeeIds":[1,2],"addedDate":"2025-05-20T14:41:40.3146781-05:00","agencyId":12,"calendarEventColor":"sample string 13","interval":"sample string 14","id":15,"location":"sample string 16","countyName":"sample string 17","townshipName":"sample string 18","agencyName":"sample string 19","calendarEventType":"sample string 20","userId":21,"calendarEventTypeId":22}]

application/xml, text/xml

Sample:

<ArrayOfCalendarEventResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.CalendarBinding">
  <CalendarEventResponseModel>
    <AddedDate>2025-05-20T14:41:40.3146781-05:00</AddedDate>
    <AgencyId>12</AgencyId>
    <AgencyName>sample string 19</AgencyName>
    <CalendarEventColor>sample string 13</CalendarEventColor>
    <CalendarEventType>sample string 20</CalendarEventType>
    <CalendarEventTypeId>22</CalendarEventTypeId>
    <CountyId>1</CountyId>
    <CountyName>sample string 17</CountyName>
    <EmployeeIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </EmployeeIds>
    <EndDate>sample string 3</EndDate>
    <EndTime>sample string 5</EndTime>
    <Id>15</Id>
    <Interval>sample string 14</Interval>
    <IsPrivate>true</IsPrivate>
    <IsReoccuring>true</IsReoccuring>
    <IsSystemWide>true</IsSystemWide>
    <Location>sample string 16</Location>
    <Notes>sample string 7</Notes>
    <StartDate>sample string 2</StartDate>
    <StartTime>sample string 4</StartTime>
    <Title>sample string 1</Title>
    <TownshipId>6</TownshipId>
    <TownshipName>sample string 18</TownshipName>
    <UserId>21</UserId>
  </CalendarEventResponseModel>
  <CalendarEventResponseModel>
    <AddedDate>2025-05-20T14:41:40.3146781-05:00</AddedDate>
    <AgencyId>12</AgencyId>
    <AgencyName>sample string 19</AgencyName>
    <CalendarEventColor>sample string 13</CalendarEventColor>
    <CalendarEventType>sample string 20</CalendarEventType>
    <CalendarEventTypeId>22</CalendarEventTypeId>
    <CountyId>1</CountyId>
    <CountyName>sample string 17</CountyName>
    <EmployeeIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </EmployeeIds>
    <EndDate>sample string 3</EndDate>
    <EndTime>sample string 5</EndTime>
    <Id>15</Id>
    <Interval>sample string 14</Interval>
    <IsPrivate>true</IsPrivate>
    <IsReoccuring>true</IsReoccuring>
    <IsSystemWide>true</IsSystemWide>
    <Location>sample string 16</Location>
    <Notes>sample string 7</Notes>
    <StartDate>sample string 2</StartDate>
    <StartTime>sample string 4</StartTime>
    <Title>sample string 1</Title>
    <TownshipId>6</TownshipId>
    <TownshipName>sample string 18</TownshipName>
    <UserId>21</UserId>
  </CalendarEventResponseModel>
</ArrayOfCalendarEventResponseModel>