Loading ...

REST API: Get Event | Axero Documentation

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

REST API: Get Event

0 
 /5
0 (0votes)
Open API Guide
GET/api/events/{EventID}

Retrieve the full details of a specific event by its ID, including its title, dates, location, description, and attendance information.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
EventIDIntegerYESPathUnique identifier for a particular event
InstanceStartStringNOQueryStart date (ISO 8601) of the occurrence of a recurring event to return. A value that is not a date answers 500.
InstanceOptionIntegerNOQueryFor a recurring event, which occurrences InstanceStart refers to: 1 = All (default), 2 = Future, 3 = Single.
LogViewBooleanNOQueryLogs the API call as an action in User Activity when set to true

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/events/14873

Success Response

{
    "IsError": false,
    "ResponseMessage": "",
    "ResponseData": {
        "CanBeViewed": true,
        "CanBeEdited": true,
        "CanBeDeleted": true,
        "iCalUID": "4ada811e-8485-4ead-b605-5d424082ca8c-0000-61e10cb9-9401-4c44-a06d-c90a3b6f6b98@myintranet",
        "IsBusy": false,
        "AttendanceType": 1,
        "IsShared": false,
        "CanInviteOthers": false,
        "InvitedByCRMContactID": 0,
        "AllowComments": true,
        "AllowLikes": true,
        "AllowRating": true,
        "EventID": 14873,
        "AlbumID": 0,
        "IsPrivate": false,
        "IsScheduled": true,
        "IsEvent": true,
        "IsClassPeriod": false,
        "MediaServerID": 78,
        "MainImageFileName": "",
        "CustomFieldOne": "",
        "CommentCount": 0,
        "EventTypeID": 552,
        "Title": "HR Leadership Summit",
        "WorkFlowID": 0,
        "CurrentWorkFlowStepID": 0,
        "SpaceName": "HR Space",
        "SpaceURL": "/spaces/715/hr-space",
        "Description": "An insightful gathering of HR professionals to discuss the latest trends and innovations in workforce management.",
        "DescriptionUnprocessed": "An insightful gathering of HR professionals to discuss the latest trends and innovations in workforce management.",
        "StartDate": "2026-02-01T14:00:00",
        "EndDate": "2026-02-01T15:30:00",
        "SpaceID": 715,
        "Views": 15,
        "IsFeatured": true,
        "IsPrivateSpace": false,
        "IsPublishedFromDraftMode": false,
        "Address": "1420 Madison Avenue,Montgomery, AL 36107,USA",
        "Address2": "TQ Plaza",
        "StateName": "United States",
        "CountryID": 617,
        "Zip": "06760",
        "EventStatusID": 1,
        "UserName": "Alexis",
        "Telephone": "9229283839",
        "CreatedOnDate": "2026-09-02T16:41:33.593",
        "Organization": "Global HR Solutions",
        "Keywords": "seminars, hr",
        "WhoShouldAttend": "HR managers, executives",
        "City": "Montgomery",
        "Website": "www.globalhrsummit.com",
        "VenueName": "Acme Conference",
        "EventTypeName": "Conference",
        "CountryName": "Alabama",
        "AttendanceID": 0,
        "UserID": 1245,
        "AvatarPath": "bbbf0b2d-0d65-42d6-babe-528e849c7383.png",
        "IsOnline": false,
        "MetroID": 0,
        "FirstName": "Alexis",
        "LastName": "Fox",
        "UserEmail": "alexis@example.com",
        "StateID": 870,
        "UserProfileURL": "https://your-site.com/people/Alexis",
        "UserDisplayName": "Alexis Fox",
        "UserAvatarFullUrl": "https://your-site.com/Assets/Uploaded-Photos/1245f0b2d-0d65-42d6-babe-528ec7383.png",
        "DateTimeSpan": "2 days ago",
        "EventURL": "/spaces/715/hr-space/events/details/14873?instance=2026-02-01T14:00:00.00",
        "EditEventURL": "/events/addedit?eventID=14873&spaceid=715",
        "StartDateText": "1/2/2024 16:00",
        "EndDateText": "1/2/2024 17:30",
        "UpdatedByUserID": 0,
        "AttendeeCount": 0,
        "MayBeAttendeeCount": 0,
        "Rating": 0.0,
        "Location": "1420 Madison Avenue,Montgomery, AL 36107,USA",
        "StartTimeText": "14:00",
        "EndTimeText": "19:30",
        "EventBookedByUserID": 1245,
        "EventBookedByUserDisplayName": "Alexis Fox",
        "EventBookedByUserProfileURL": "https://your-site.com/people/Alexis",
        "TagIDCSV": "1094, 674",
        "Tags": [
            {
                "TagID": 674,
                "TagGroupID": 674,
                "TagName": "hr",
                "EntityID": 0,
                "EntityType": 0,
                "SpaceID": 0,
                "TagWeight": 0,
                "TagCount": 1,
                "IsPromoted": false
            },
            {
                "TagID": 1094,
                "TagGroupID": 1094,
                "TagName": "seminars",
                "EntityID": 0,
                "EntityType": 0,
                "SpaceID": 0,
                "TagWeight": 0,
                "TagCount": 1,
                "IsPromoted": false
            }
        ],
        "Reminders": [
            {
                "ReminderID": 9300502,
                "EntityType": 5,
                "EntityID": 14873,
                "ReminderType": 1,
                "ReminderTime": 30,
                "UserID": 1245,
                "ReminderSent": false
            },
            {
                "ReminderID": 9300503,
                "EntityType": 5,
                "EntityID": 14873,
                "ReminderType": 1,
                "ReminderTime": 10,
                "UserID": 1245,
                "ReminderSent": false
            }
        ],
        "IsAllDay": false,
        "StartDateISO": "2026-02-01T16:00:00.00",
        "EndDateISO": "2026-02-01T17:30:00.00",
        "MaxAttendees": 200,
        "FrequencyChoice": 4,
        "Frequency": 4,
        "DaysOfWeek": 16,
        "IsRepeat": true,
        "QuarterInterval": 0,
        "QuarterlyInterval": 0,
        "MonthlyInterval": 1,
        "WeeklyInterval": 2,
        "DaysOfMonth": 15,
        "IsSundaySelected": false,
        "IsMondaySelected": false,
        "IsTuesdaySelected": false,
        "IsWednesdaySelected": false,
        "IsThursdaySelected": true,
        "IsFridaySelected": false,
        "IsSaturdaySelected": false,
        "IsFirstWeekOfMonthSelected": true,
        "IsSecondWeekOfMonthSelected": false,
        "IsThirdWeekOfMonthSelected": false,
        "IsFourthWeekOfMonthSelected": false,
        "IsLastWeekOfMonthSelected": false,
        "FrequencyTypeOption": 4,
        "QuarterlyOptions": 0,
        "QuarterlyIntervalOptions": 0,
        "MonthlyIntervalOptions": 1,
        "WeeklyIntervalOptions": 2,
        "DaysOfWeekOptions": 16,
        "RangeStartMonth": 0,
        "RangeEndMonth": 0,
        "FirstInstanceDate": "2026-02-01T14:00:00",
        "RepeatStartDate": "2026-02-01T14:00:00",
        "RepeatStartDateISO": "2026-02-01T16:00:00.00",
        "MonthRepeatBy": 2,
        "EndAfterOccurences": 5,
        "DayInterval": 2,
        "MonthInterval": 2,
        "DayOfMonth": 15,
        "YearInterval": 2,
        "RepeatEndType": 2,
        "StartDateWithRespectToUser": "2026-02-01T16:00:00",
        "EndDateWithRespectToUser": "2026-02-01T17:30:00",
        "RepeatStartDateWithRespectToUser": "2026-02-01T16:00:00",
        "RepeatEndDateWithRespectToUser": "0001-01-01T00:00:00",
        "SeriesEventID": 0,
        "InstanceReplaceDate": "2026-02-01T14:00:00",
        "InstanceExceptions": 0,
        "InstanceChanges": 0,
        "When": "1/2/2024 16:00   17:30 (GTB Standard Time)",
        "RepeatSummary": "Every 2 months on the first Thursday, 5 times",
        "ResourceIDCSV": "15,16",
        "TimezoneOffset": 2.0,
        "TimeZoneID": "GTB Standard Time",
        "IsDayLightSaving": false,
        "InstanceNumber": 0,
        "DateUpdated": "2026-09-04T16:53:14.16",
        "LatestUserIDUpdated": 1245
    }
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestEventID in the path is not an integer.Send the event's numeric ID.
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.
200 with IsErrorNo event has that ID, or the caller cannot view it (Not a valid eventID.).Check the EventID.
500 Server ErrorInternal failure.Retry later.

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