Loading ...

REST API: Get Calendar Events | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Get Calendar Events
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 63

REST API: Get Calendar Events

0 
 /5
0 (0votes)
Open API Guide
GET/api/calendars/events

Get a list of space events or personal events

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerYESQueryUnique ID of space
EventViewSourceIntegerYESQueryThe source of the events: Community = 1, Space = 2, MyAccount = 3, Resource = 4, Availability = 5.
StartDateISOStringYESQueryThe event start date in ISO format
EndDateISOStringYESQueryThe event end date in ISO format

Optional Parameters

ParameterTypeRequiredLocationDescription
SpaceLevelIDIntegerNOQuerySpaceID of the calendar being viewed, used to set the calendar properties on each event returned. Defaults to 0.
ExcludeEventsOnViewerCalendarBooleanNOQueryLeave 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": ""
    }
  ]
}

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 CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (spaceID, eventViewSource, startDateISO, endDateISO)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.
404 or 405A 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 is not about the resource.

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.

Wiki Index

Pages