---
title: "REST API: Get Events"
type: "wiki"
space: "Axero Documentation"
author: "Anonymous User"
created: 2011-03-29T05:27:10Z
updated: 2026-09-28T01:14:10Z
tags: ["API"]
url: "https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/495/rest-api-get-events"
---

# REST API: Get Events

[Open API Guide](https://my.axerosolutions.com/spaces/5/axero-documentation/api-guide?id=495)
GET/api/events

Get a list of events from the intranet calendar, filtered by space, creator, date range, event type, or venue. Results can be sorted and split into pages.

## 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). |
### Optional Parameters
| Parameter | Type | Required | Location | Description |
| :--- | :--- | :--- | :--- | :--- |
| `UserID` | Integer | NO | Query | ID of the user who created the event |
| `ShowSubscribedEvents` | Boolean | NO | Query | true \(default\) returns events the user is attending or, with a UserID, the events that user is attending. false returns events regardless of attendance. Combine false with a UserID to get the events that user created. |
| `SpaceID` | Integer | NO | Query | ID of the space from which the events are returned. Omit for every space the caller belongs to. |
| `EntityStatus` | String | NO | Query | Status of the events to return: PendingWorkflow = 0, Published = 1, Draft = 2, Declined = 3, Updated = 4, Expired = 5, Spam = 6, All = 7, DelayedPublishing = 8. Default when omitted: All = 7. |
| `IsFeatured` | Boolean | NO | Query | Used to get events marked as "featured" |
| `EventType` | Integer | NO | Query | ID of the event type to return |
| `StartDate` | String | NO | Query | The event start date |
| `EndDate` | String | NO | Query | The event end date |
| `DateRange` | String | NO | Query | Date range of events to return. See [REST API: Event List Display Types](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/25229/rest-api-event-list-display-types "REST API: Event List Display Types"). |
| `VenueName` | String | NO | Query | Name of the event venue |
| `Keywords` | String | NO | Query | Keywords for the event |
| `Month` | String | NO | Query | The calendar month, as a number. All events in that month are returned. |
| `AttendanceType` | Integer | NO | Query | RSVP status to filter by: 1 = Attending, 2 = Maybe attending, 3 = Not attending, 4 = All, 5 = Awaiting response, 6 = Shared. Default when omitted: 4 \(All\). Any other value without a UserID filters on the caller. |
| `ResourceID` | Integer | NO | Query | Unique ID of the event resource to filter results by. Use [REST API: Get Event Resources](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/42776/rest-api-get-event-resources "REST API: Get Event Resources") to get event resource IDs. |
| `City` | String | NO | Query | City to filter results by |
| `StateID` | Integer | NO | Query | Unique ID of the state to filter results by. Use [REST API: Get States](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/42775/rest-api-get-states "REST API: Get States")  to get state IDs. |
| `CountryID` | Integer | NO | Query | Unique ID of the country to filter results by. Use [REST API: Get Countries](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/42774/rest-api-get-countries "REST API: Get Countries") to get country IDs. |
| `SortColumn` | String | NO | Query | Column to sort by: Unspecified = 0, Title = 1, DateCreated = 2, StartDate = 3, EndDate = 4, IsFeatured = 5, Rating = 6, Views = 7, Comments = 8. A value that is not one of these numbers, including a column name such as Title, answers 500 with an empty body. |
| `SortOrder` | String | NO | Query | Sort direction: Ascending = 0, Descending = 1, Unspecified = 2 \(default\). A value that is not a number is read as Unspecified rather than refused. |
| `StartPage` | Integer | NO | Query | Page of results to return. Default: 1. |
| `PageLength` | Integer | NO | Query | Number of results to return per page. When omitted, every matching event is returned in one page. |
| `Tags` | String | NO | Query | Comma-separated tags. Only events carrying at least one of them are returned. |
| `UtcStartDate` | Boolean | NO | Query | true when StartDate and EndDate are already in UTC. When false they are converted from the caller's time zone. Defaults to false. |
| `SpaceLevelID` | Integer | NO | Query | SpaceID of the calendar being viewed. When that space has Enable events from other spaces in calendar turned on, events from the spaces selected in its calendar settings are included. Defaults to 0. |
## Example

### Request Header

```
Authorization: Bearer YOUR_TOKEN
```

### Request URL

`https://your-site.com/api/events?UserID=1&SpaceID=0&EntityStatus=1&EventType=1&Month=1&SortColumn=1&SortOrder=1&StartPage=1&PageLength=100`

### Success Response

```
{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "EventID": 180,
      "AlbumID": 0,
      "IsPrivate": false,
      "IsScheduled": false,
      "MediaServerID": 3,
      "CommentCount": 2,
      "EventTypeID": 1,
      "Title": "Workshop",
      "WorkFlowID": 0,
      "Description": "<p>Workshop</p>",
      "DescriptionUnprocessed": "<p>Workshop</p>",
      "StartDate": "2026-12-15T05:45:00",
      "EndDate": "2026-12-25T05:45:00",
      "SpaceID": 0,
      "Views": 6,
      "IsFeatured": false,
      "Address": "",
      "Zip": "",
      "EventStatusID": 1,
      "UserName": "John",
      "Telephone": "",
      "CreatedOnDate": "2026-12-15T05:56:09.99",
      "Organization": "",
      "WhoShouldAttend": "",
      "Website": "",
      "VenueName": "",
      "EventTypeName": "Conference",
      "AttendanceID": 0,
      "AttendanceTypeID": 0,
      "UserID": 1,
      "EntryDate": "0001-01-01T00:00:00",
      "AvatarPath": "f1e4e4b4-064a-4109-baab-69b145eea377.jpg",
      "IsOnline": false,
      "FirstName": "John",
      "LastName": "smith",
      "UserEmail": "acme@acme.com",
      "UserProfileURL": "http://your-site.com/people/john",
      "UserDisplayName": "John smith",
      "UserAvatarFullUrl": "http://your-site.com/Assets/Uploaded-Photos/f1e4e4b4-064a-4109-baab-69b145eea377.jpg",
      "DateTimeSpan": "12/15/2015",
      "EventURL": "/events/details/180",
      "EditEventURL": "/myaccount/events/addedit?eventID=180",
      "StartDateText": "12/15/2015 11:15 AM",
      "EndDateText": "12/25/2015 11:15 AM",
      "UpdatedByUserID": 0,
      "AttendeeCount": 0,
      "MayBeAttendeeCount": 0,
      "Rating": 2.7199999999999998,
      "Location": "",
      "StartTimeText": "11:15 AM",
      "EndTimeText": "11:15 AM",
      "EventBookedByUserID": 0,
      "IsAllDay": false,
      "StartDateISO": "2026-12-15T11:15:00.00Z",
      "EndDateISO": "2026-12-25T11:15:00.00Z",
      "DaysOfWeek": 0,
      "IsRepeat": false,
      "QuarterInterval": 0,
      "QuarterlyInterval": 0,
      "MonthlyInterval": 0,
      "WeeklyInterval": 0,
      "DaysOfMonth": 0,
      "FrequencyTypeOptions": 0,
      "QuarterlyOptions": 0,
      "QuarterlyIntervalOptions": 0,
      "MonthlyIntervalOptions": 0,
      "DaysOfWeekOptions": 0,
      "RangeStartMonth": 0,
      "RangeEndMonth": 0,
      "RepeatStartDate": "2026-12-15T05:45:00",
      "RepeatStartDateISO": "2026-12-15T11:15:00.00Z",
      "EndAfterOccurences": 0,
      "DayInterval": 0,
      "MonthInterval": 0,
      "DayOfMonth": 0,
      "YearInterval": 0,
      "StartDateWithRespectToUser": "2026-12-15T11:15:00",
      "EndDateWithRespectToUser": "2026-12-25T11:15:00",
      "RepeatStartDateWithRespectToUser": "2026-12-15T11:15:00",
      "RepeatEndDateWithRespectToUser": "0001-01-01T00:00:00",
      "When": "12/15/2015 11:15 AM - 12/25/2015 11:15 AM (India Standard Time)",
      "RepeatSummary": ""
    },
    {
      "EventID": 201,
      "AlbumID": 0,
      "IsPrivate": false,
      "IsScheduled": false,
      "MediaServerID": 3,
      "CommentCount": 0,
      "EventTypeID": 1,
      "Title": "Ready to work.",
      "WorkFlowID": 0,
      "Description": "General discussion.",
      "DescriptionUnprocessed": "General discussion.",
      "StartDate": "2026-01-02T00:00:00",
      "EndDate": "2026-01-03T00:00:00",
      "SpaceID": 0,
      "Views": 0,
      "IsFeatured": false,
      "Address": "",
      "Zip": "",
      "EventStatusID": 1,
      "UserName": "john",
      "Telephone": "",
      "CreatedOnDate": "2026-02-08T20:08:34.307",
      "Organization": "",
      "WhoShouldAttend": "",
      "Website": "",
      "VenueName": "",
      "EventTypeName": "Conference",
      "AttendanceID": 0,
      "AttendanceTypeID": 0,
      "UserID": 1,
      "EntryDate": "0001-01-01T00:00:00",
      "AvatarPath": "f1e4e4b4-064a-4109-baab-69b145eea377.jpg",
      "IsOnline": false,
      "FirstName": "John",
      "LastName": "Smith",
      "UserEmail": "acme@acme.com",
      "UserProfileURL": "http://your-site.com/people/john",
      "UserDisplayName": "John smith",
      "UserAvatarFullUrl": "http://your-site.com/Assets/Uploaded-Photos/f1e4e4b4-064a-4109-baab-69b145eea377.jpg",
      "DateTimeSpan": "a minute ago",
      "EventURL": "/events/details/201",
      "EditEventURL": "/myaccount/events/addedit?eventID=201",
      "StartDateText": "1/2/2016 05:30 AM",
      "EndDateText": "1/3/2016 05:30 AM",
      "UpdatedByUserID": 0,
      "AttendeeCount": 0,
      "MayBeAttendeeCount": 0,
      "Rating": 0,
      "Location": "",
      "StartTimeText": "05:30 AM",
      "EndTimeText": "05:30 AM",
      "EventBookedByUserID": 0,
      "IsAllDay": false,
      "StartDateISO": "2026-01-02T05:30:00.00Z",
      "EndDateISO": "2026-01-03T05:30:00.00Z",
      "DaysOfWeek": 0,
      "IsRepeat": false,
      "QuarterInterval": 0,
      "QuarterlyInterval": 0,
      "MonthlyInterval": 0,
      "WeeklyInterval": 0,
      "DaysOfMonth": 0,
      "FrequencyTypeOptions": 0,
      "QuarterlyOptions": 0,
      "QuarterlyIntervalOptions": 0,
      "MonthlyIntervalOptions": 0,
      "DaysOfWeekOptions": 0,
      "RangeStartMonth": 0,
      "RangeEndMonth": 0,
      "RepeatStartDate": "2026-01-02T00:00:00",
      "RepeatStartDateISO": "2026-01-02T05:30:00.00Z",
      "EndAfterOccurences": 0,
      "DayInterval": 0,
      "MonthInterval": 0,
      "DayOfMonth": 0,
      "YearInterval": 0,
      "StartDateWithRespectToUser": "2026-01-02T05:30:00",
      "EndDateWithRespectToUser": "2026-01-03T05:30:00",
      "RepeatStartDateWithRespectToUser": "2026-01-02T05:30:00",
      "RepeatEndDateWithRespectToUser": "0001-01-01T00:00:00",
      "When": "1/2/2016 05:30 AM - 1/3/2016 05:30 AM (India Standard Time)",
      "RepeatSummary": ""
    },
    {
      "EventID": 202,
      "AlbumID": 0,
      "IsPrivate": false,
      "IsScheduled": false,
      "MediaServerID": 3,
      "CommentCount": 0,
      "EventTypeID": 1,
      "Title": "Trip to chicago",
      "WorkFlowID": 0,
      "Description": "Trip to chicago on monday.",
      "DescriptionUnprocessed": "Trip to chicago on monday.",
      "StartDate": "2026-01-02T00:00:00",
      "EndDate": "2026-01-03T00:00:00",
      "SpaceID": 0,
      "Views": 0,
      "IsFeatured": false,
      "Address": "",
      "Zip": "",
      "EventStatusID": 1,
      "UserName": "john",
      "Telephone": "",
      "CreatedOnDate": "2026-02-08T20:09:53.737",
      "Organization": "",
      "WhoShouldAttend": "",
      "Website": "",
      "VenueName": "",
      "EventTypeName": "Conference",
      "AttendanceID": 0,
      "AttendanceTypeID": 0,
      "UserID": 1,
      "EntryDate": "0001-01-01T00:00:00",
      "AvatarPath": "f1e4e4b4-064a-4109-baab-69b145eea377.jpg",
      "IsOnline": false,
      "FirstName": "John",
      "LastName": "smith",
      "UserEmail": "acme@acme.com",
      "UserProfileURL": "http://your-site.com/people/john",
      "UserDisplayName": "John smith",
      "UserAvatarFullUrl": "http://your-site.com/Assets/Uploaded-Photos/f1e4e4b4-064a-4109-baab-69b145eea377.jpg",
      "DateTimeSpan": "20 seconds ago",
      "EventURL": "/events/details/202",
      "EditEventURL": "/myaccount/events/addedit?eventID=202",
      "StartDateText": "1/2/2016 05:30 AM",
      "EndDateText": "1/3/2016 05:30 AM",
      "UpdatedByUserID": 0,
      "AttendeeCount": 0,
      "MayBeAttendeeCount": 0,
      "Rating": 0,
      "Location": "",
      "StartTimeText": "05:30 AM",
      "EndTimeText": "05:30 AM",
      "EventBookedByUserID": 0,
      "IsAllDay": false,
      "StartDateISO": "2026-01-02T05:30:00.00Z",
      "EndDateISO": "2026-01-03T05:30:00.00Z",
      "DaysOfWeek": 0,
      "IsRepeat": false,
      "QuarterInterval": 0,
      "QuarterlyInterval": 0,
      "MonthlyInterval": 0,
      "WeeklyInterval": 0,
      "DaysOfMonth": 0,
      "FrequencyTypeOptions": 0,
      "QuarterlyOptions": 0,
      "QuarterlyIntervalOptions": 0,
      "MonthlyIntervalOptions": 0,
      "DaysOfWeekOptions": 0,
      "RangeStartMonth": 0,
      "RangeEndMonth": 0,
      "RepeatStartDate": "2026-01-02T00:00:00",
      "RepeatStartDateISO": "2026-01-02T05:30:00.00Z",
      "EndAfterOccurences": 0,
      "DayInterval": 0,
      "MonthInterval": 0,
      "DayOfMonth": 0,
      "YearInterval": 0,
      "StartDateWithRespectToUser": "2026-01-02T05:30:00",
      "EndDateWithRespectToUser": "2026-01-03T05:30:00",
      "RepeatStartDateWithRespectToUser": "2026-01-02T05:30:00",
      "RepeatEndDateWithRespectToUser": "0001-01-01T00:00:00",
      "When": "1/2/2016 05:30 AM - 1/3/2016 05:30 AM (India Standard Time)",
      "RepeatSummary": ""
    }
  ]
}
```

### Error Response

```
HTTP 500 with an empty body
```

## Error Handling

| Status Code | Likely Cause | Next Action |
| :--- | :--- | :--- |
| 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 | User does not have sufficient permissions. | Confirm the user has the required roles for this action. |
| 500 Server Error | A numeric filter \(SortColumn, PageLength, StartPage, Month, EventType, EntityStatus, SpaceID, or UserID\) is sent a value that is not a whole number, such as a column name or a comma-separated list. The body is empty. | Send each of these filters as a single whole number; SortColumn and the others accept only the listed numeric values. |
| 200 with IsError | The caller cannot read events in any of the spaces asked for \(No permission\). | Check the SpaceID and the caller's rights. |

## 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.