 API: Calendar
Events on the members-area calendar, in any status. Defaults to today through the next 30 days; All=1 lists every event with no date window.
Calling the Endpoint
| HTTP Request Type | GET |
| Calling URI | https://www.YourDepartment.com/apps/api/calendar/ |
| Request Header | Authorization: Bearer {access_token} |
Parameters
| Parameter | Description |
ID |
Optional. A single event ID. Returned regardless of its dates. |
CalendarID |
Optional. Limit to one calendar (the calendarId value). |
All |
Optional. 1 = list every event with no date window. |
StartDate |
Optional. Start of the date range; events overlapping the range are returned. Default: today. |
EndDate |
Optional. End of the date range. Default: 30 days from today. |
Response Properties
| Property | Description |
id |
Event ID (number) |
calendarId |
Calendar ID (number) |
calendar |
Calendar name (string) |
title |
Event title (string) |
status |
Status: 0 = Pending, 1 = Offline, 2 = Online (number) |
startDate |
Event start date (string, yyyy-mm-dd) |
endDate |
Event end date (string, yyyy-mm-dd) |
allDay |
1 = all-day event (number) |
startTime |
Start time when not all-day (string) |
endTime |
End time when not all-day (string) |
location |
Location (string) |
contact |
Point of contact (string) |
text |
Event details (string) |
created |
Created date/time (string) |
createdBy |
Creating member's name (string) |
modified |
Last modified date/time; empty if never modified (string) |
modifiedBy |
Modifying member's name; empty if never modified (string) |
Sample Request
GET https://www.YourDepartment.com/apps/api/calendar/?MaxRows=1
Authorization: Bearer {access_token}
Sample Response
{
"status": 200,
"endpoint": "calendar",
"domain": "www.YourDepartment.com",
"generated": "2026-09-06 09:15:00",
"startRow": 1,
"maxRows": 1,
"count": 1,
"totalCount": 12,
"startDate": "2026-09-06",
"endDate": "2026-10-06",
"items": [
{
"id": 587,
"calendarId": 2,
"calendar": "Company Events",
"title": "Monthly Company Meeting",
"status": 2,
"startDate": "2026-09-10",
"endDate": "2026-09-10",
"allDay": 0,
"startTime": "19:00:00",
"endTime": "21:00:00",
"location": "Station 1 Meeting Hall",
"contact": "Chief Miller",
"text": "Regular monthly company meeting. All members are expected to attend.",
"created": "2026-08-15 10:05:00",
"createdBy": "Jane Doe",
"modified": "",
"modifiedBy": ""
}
]
}
Records are returned in the items array. count is the
number of records in this response; totalCount is all matching records regardless of paging. Page with
StartRow and MaxRows (default 100, maximum 1000) until count + startRow exceeds totalCount.
Back to the API Documentation
|
September 21, 2026: