--- title: "REST API: Get Calendar Events" type: "wiki" space: "Axero Documentation" author: "Anonymous User" created: 2014-10-31T19:43:06Z updated: 2026-09-28T01:12:45Z tags: ["API"] url: "https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/2169/rest-api-get-calendar-events" --- # REST API: Get Calendar Events [Open API Guide](https://my.axerosolutions.com/spaces/5/axero-documentation/api-guide?id=2169) GET/api/calendars/events Get a list of space events or personal events ## Request ### Request Header | Header | Required | Value | Description | | :--- | :--- | :--- | :--- | | `Authorization` | YES | `Bearer YOUR_TOKEN` | Bearer token for the authenticated user. [Learn how to create Bearer tokens](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/108973/creating-bearer-tokens). | ### Required Parameters | Parameter | Type | Required | Location | Description | | :--- | :--- | :--- | :--- | :--- | | `SpaceID` | Integer | YES | Query | Unique ID of space | | `EventViewSource` | Integer | YES | Query | The source of the events: Community = 1, Space = 2, MyAccount = 3, Resource = 4, Availability = 5. | | `StartDateISO` | String | YES | Query | Start of the date range to return events for, in ISO 8601 format. It is read in the time zone of the user making the request, except when EventViewSource is Availability. | | `EndDateISO` | String | YES | Query | End of the date range to return events for, in ISO 8601 format, read the same way as StartDateISO. | ### Optional Parameters | Parameter | Type | Required | Location | Description | | :--- | :--- | :--- | :--- | :--- | | `SpaceLevelID` | Integer | NO | Query | SpaceID of the calendar being viewed. When it is 0, private events are left out. A value above 0 also limits the events to that space. Defaults to 0. | | `ExcludeEventsOnViewerCalendar` | Boolean | NO | Query | Leave out events already on the viewer's own calendar, which removes duplicates when a personal calendar is shown together with shared ones. Defaults to false. | ## Example ### Request Header ``` Authorization: Bearer YOUR_TOKEN ``` ### Request URL `https://your-site.com/api/calendars/events?SpaceID=0&EventViewSource=3&StartDateISO=2026-01-01T00:00:00.000Z&EndDateISO=2026-12-04T00:00:00.000Z` ### Success Response ``` { "IsError": false, "ResponseMessage": "", "ResponseData": [ { "CanBeViewed": true, "CanBeEdited": true, "CanBeDeleted": true, "CalendarID": 376, "EventSource": 1, "EventSourceString": "internal", "IsBusy": true, "AttendanceType": 1, "IsShared": false, "CanInviteOthers": true, "InvitedByCRMContactID": 0, "EventID": 549, "AlbumID": 0, "IsPrivate": true, "IsScheduled": false, "IsEvent": false, "IsClassPeriod": false, "MediaServerID": 64, "MainImageFileName": "", "CommentCount": 0, "EventTypeID": 258, "Title": "Laura and Alexis 1:1 Meeting", "WorkFlowID": 0, "CurrentWorkFlowStepID": 0, "Description": "", "DescriptionUnprocessed": "", "StartDate": "2026-01-01T12:00:00Z", "EndDate": "2026-01-01T12:00:00Z", "SpaceID": 252, "Views": 0, "IsFeatured": false, "IsPrivateSpace": false, "IsPublishedFromDraftMode": false, "Address": "", "Address2": "", "CountryID": 0, "Zip": "", "EventStatusID": 1, "UserName": "admin", "Telephone": "", "CreatedOnDate": "2026-01-01T12:00:00Z", "Organization": "", "Keywords": "", "WhoShouldAttend": "", "City": "", "Website": "", "VenueName": "", "EventTypeName": "Appointment", "AttendanceID": 0, "UserID": 376, "AvatarPath": "1c32c413-8025-4da5-b23a-575ab251faf4.png", "IsOnline": false, "MetroID": 0, "FirstName": "Alexis", "LastName": "Fox", "UserEmail": "alexis.fox@your-site.com", "StateID": 0, "UserProfileURL": "https://your-site.com/people/admin", "UserDisplayName": "Alexis Fox", "UserAvatarFullUrl": "https://your-site.com/Assets/Uploaded-Photos/376/1c32c413-8025-4da5-b23a-575ab251faf4.png", "DateTimeSpan": "2026-01-01T12:00:00Z", "EventURL": "/events/details/549", "EditEventURL": "/events/addedit?eventID=549", "StartDateText": "2026-01-01T12:00:00Z", "EndDateText": "2026-01-01T12:00:00Z", "UpdatedByUserID": 0, "AttendeeCount": 2, "MayBeAttendeeCount": 0, "Rating": 0, "Location": "", "StartTimeText": "10:00 AM", "EndTimeText": "10:30 AM", "EventBookedByUserID": 0, "Tags": [], "Reminders": [ { "ReminderID": 896, "EntityType": 3, "EntityID": 220, "ReminderType": 1, "ReminderTime": 30, "UserID": 376, "ReminderSent": true }, { "ReminderID": 897, "EntityType": 3, "EntityID": 220, "ReminderType": 1, "ReminderTime": 10, "UserID": 376, "ReminderSent": true } ], "IsAllDay": false, "StartDateISO": "2026-01-01T12:00:00Z", "EndDateISO": "2026-01-01T12:00:00Z", "FrequencyChoice": 0, "Frequency": 0, "DaysOfWeek": 0, "IsRepeat": false, "QuarterInterval": 0, "QuarterlyInterval": 0, "MonthlyInterval": 0, "WeeklyInterval": 0, "DaysOfMonth": 0, "IsSundaySelected": false, "IsMondaySelected": false, "IsTuesdaySelected": false, "IsWednesdaySelected": false, "IsThursdaySelected": false, "IsFridaySelected": false, "IsSaturdaySelected": false, "IsFirstWeekOfMonthSelected": false, "IsSecondWeekOfMonthSelected": false, "IsThirdWeekOfMonthSelected": false, "IsFourthWeekOfMonthSelected": false, "IsLastWeekOfMonthSelected": false, "FrequencyTypeOption": 0, "QuarterlyOptions": 0, "QuarterlyIntervalOptions": 0, "MonthlyIntervalOptions": 0, "WeeklyIntervalOptions": 0, "DaysOfWeekOptions": 0, "RangeStartMonth": 0, "RangeEndMonth": 0, "RepeatStartDate": "2026-01-01T12:00:00Z", "RepeatStartDateISO": "2026-01-01T12:00:00Z", "EndAfterOccurences": 0, "DayInterval": 0, "MonthInterval": 0, "DayOfMonth": 0, "YearInterval": 0, "RepeatEndType": 1, "StartDateWithRespectToUser": "2026-01-01T12:00:00Z", "EndDateWithRespectToUser": "2026-01-01T12:00:00Z", "RepeatStartDateWithRespectToUser": "2026-01-01T12:00:00Z", "RepeatEndDateWithRespectToUser": "2026-01-01T12:00:00Z", "When": "2026-01-01T12:00:00Z 10:00 AM 10:30 AM (Pacific Daylight Time)", "RepeatSummary": "", "ResourceIDCSV": "" }, { "CanBeViewed": true, "CanBeEdited": true, "CanBeDeleted": true, "CalendarID": 376, "EventSource": 1, "EventSourceString": "internal", "IsBusy": true, "AttendanceType": 1, "IsShared": false, "CanInviteOthers": true, "InvitedByCRMContactID": 0, "EventID": 548, "AlbumID": 0, "IsPrivate": true, "IsScheduled": false, "IsEvent": false, "IsClassPeriod": false, "MediaServerID": 64, "MainImageFileName": "", "CommentCount": 0, "EventTypeID": 258, "Title": "Doctor's Appointment", "WorkFlowID": 0, "CurrentWorkFlowStepID": 0, "Description": "", "DescriptionUnprocessed": "", "StartDate": "2026-01-01T12:00:00Z", "EndDate": "2026-01-01T12:00:00Z", "SpaceID": 252, "Views": 1, "IsFeatured": false, "IsPrivateSpace": false, "IsPublishedFromDraftMode": false, "Address": "", "Address2": "", "CountryID": 0, "Zip": "", "EventStatusID": 1, "UserName": "admin", "Telephone": "", "CreatedOnDate": "2026-01-01T12:00:00Z", "Organization": "", "Keywords": "", "WhoShouldAttend": "", "City": "", "Website": "", "VenueName": "", "EventTypeName": "Appointment", "AttendanceID": 0, "UserID": 376, "AvatarPath": "1c32c413-8025-4da5-b23a-575ab251faf4.png", "IsOnline": false, "MetroID": 0, "FirstName": "Alexis", "LastName": "Fox", "UserEmail": "alexis.fox@your-site.com", "StateID": 0, "UserProfileURL": "https://your-site.com/people/admin", "UserDisplayName": "Alexis Fox", "UserAvatarFullUrl": "https://your-site.com/Assets/Uploaded-Photos/376/1c32c413-8025-4da5-b23a-575ab251faf4.png", "DateTimeSpan": "2026-01-01T12:00:00Z", "EventURL": "/events/details/548", "EditEventURL": "/events/addedit?eventID=548", "StartDateText": "2026-01-01T12:00:00Z", "EndDateText": "2026-01-01T12:00:00Z", "UpdatedByUserID": 0, "AttendeeCount": 1, "MayBeAttendeeCount": 0, "Rating": 0, "Location": "", "StartTimeText": "1:00 PM", "EndTimeText": "2:00 PM", "EventBookedByUserID": 0, "Tags": [], "Reminders": [ { "ReminderID": 894, "EntityType": 3, "EntityID": 220, "ReminderType": 1, "ReminderTime": 30, "UserID": 376, "ReminderSent": true }, { "ReminderID": 895, "EntityType": 3, "EntityID": 220, "ReminderType": 1, "ReminderTime": 10, "UserID": 376, "ReminderSent": true } ], "IsAllDay": false, "StartDateISO": "2026-01-01T12:00:00Z", "EndDateISO": "2026-01-01T12:00:00Z", "FrequencyChoice": 0, "Frequency": 0, "DaysOfWeek": 0, "IsRepeat": false, "QuarterInterval": 0, "QuarterlyInterval": 0, "MonthlyInterval": 0, "WeeklyInterval": 0, "DaysOfMonth": 0, "IsSundaySelected": false, "IsMondaySelected": false, "IsTuesdaySelected": false, "IsWednesdaySelected": false, "IsThursdaySelected": false, "IsFridaySelected": false, "IsSaturdaySelected": false, "IsFirstWeekOfMonthSelected": false, "IsSecondWeekOfMonthSelected": false, "IsThirdWeekOfMonthSelected": false, "IsFourthWeekOfMonthSelected": false, "IsLastWeekOfMonthSelected": false, "FrequencyTypeOption": 0, "QuarterlyOptions": 0, "QuarterlyIntervalOptions": 0, "MonthlyIntervalOptions": 0, "WeeklyIntervalOptions": 0, "DaysOfWeekOptions": 0, "RangeStartMonth": 0, "RangeEndMonth": 0, "RepeatStartDate": "2026-01-01T12:00:00Z", "RepeatStartDateISO": "2026-01-01T12:00:00Z", "EndAfterOccurences": 0, "DayInterval": 0, "MonthInterval": 0, "DayOfMonth": 0, "YearInterval": 0, "RepeatEndType": 1, "StartDateWithRespectToUser": "2026-01-01T12:00:00Z", "EndDateWithRespectToUser": "2026-01-01T12:00:00Z", "RepeatStartDateWithRespectToUser": "2026-01-01T12:00:00Z", "RepeatEndDateWithRespectToUser": "2026-01-01T12:00:00Z", "When": "2026-01-01T12:00:00Z 1:00 PM 2:00 PM (Pacific Daylight Time)", "RepeatSummary": "", "ResourceIDCSV": "" } ] } ``` ### Response dates `StartDateWithRespectToUser` and `EndDateWithRespectToUser` are in the time zone of the user making the request. `StartDateISO` and `EndDateISO` depend on the event: - A single timed event: UTC. - A single all-day event: the date in the time zone of the person who created it. - A repeating event \(`IsRepeat` is true\): the requesting user's local time, still ending in `Z`. Read these as local time and ignore the `Z`. Otherwise the event shifts by the user's offset, and an all-day event can land a day early. ### Error Response ``` { "Message": "No HTTP resource was found that matches the request URI 'https://your-site.com/api/calendars/events?EventViewSource=1&StartDateISO=2026-09-01T00%3A00%3A00&EndDateISO=2026-09-01T00%3A00%3A00'." } ``` ## Error Handling | Status Code | Likely Cause | Next Action | | :--- | :--- | :--- | | 400 Bad Request | SpaceID is not an integer, or EventViewSource is not one of its values; the body reads The request is invalid. | Send SpaceID as a number and EventViewSource as a number or value name from the list above. | | 401 Unauthorized | Missing or invalid Bearer token. | Check token validity. [Learn how to create Bearer tokens →](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/108973/creating-bearer-tokens) | | 403 Forbidden | Not returned: events the caller cannot see are left out of the results. | Call as a user who can see the events you expect. | | 500 Server Error | StartDateISO or EndDateISO is not a date the server can read, and the body is empty. | Send both dates in ISO 8601 format, such as 2026-09-01T00:00:00. | | 404 or 405 | A required query parameter was left out, so the request matched a different action or none. The message reads No HTTP resource was found or The requested resource does not support http method. | Send every required query parameter. The message does not mean the item you asked for is missing. | ## Rate Limits While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance: - **Sustained Request Rate:** Do not exceed 5 API calls per second - **Sequential Processing:** Wait for each request to complete before sending the next in automated workflows - **Concurrent Connections:** If parallel processing is required, limit to 3 or fewer simultaneous requests - **Response Timeout:** Ensure API responses complete within 15 seconds during testing Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.