GET /v1/calendar/events/{id}

Searches for an event by id, in one of conditions: The calendar of the event is public, OR the authenticated user is the owner of the calendar, OR the user belongs to the group of the calendar, OR the user is a participant of the event, OR the calendar of the event has been shared with the user or with a group of the user.



Supported Format: JSON


  • Required (path parameters):

Parameter Description
id Identity of the event.
  • Optional (query parameters):

Parameter Description
fields Comma-separated list of selective event attributes to be returned. All returned if not specified.
expand Used to ask for more attributes of a sub-resource, instead of its link only. This is a comma-separated list of property names. For example: expand=calendar,categories. In case of collections, you can specify offset (default: 0), limit (default: querylimit ). For example, expand=categories(1,5). Instead of: { "calendar": "http://localhost:8080/rest/private/v1/calendar/calendars/john-defaultCalendarId", } It returns: { "calendar": { "editPermission": "", "viewPermission": "", "privateURL": null, "publicURL": null, "icsURL": "http://localhost:8080/rest/private/v1/calendar/calendars/john-defaultCalendarId/ics", "description": null, "color": "asparagus", "timeZone": "Europe/Brussels", "name": "John Smith", "type": "0", "owner": "john", "groups": null, "href": "http://localhost:8080/rest/private/v1/calendar/calendars/john-defaultCalendarId", "id": "john-defaultCalendarId" }, }
jsonp The name of a JavaScript function to be used as the JSONP callback. If not specified, only JSON object is returned.

Request example:

GET: http://localhost:8080/rest/private/v1/calendar/events/Event123


   "to": "2015-07-24T01:30:00.000Z",
   "attachments": [],
   "from": "2015-07-24T01:00:00.000Z",
   "categories": [
   "categoryId": "defaultEventCategoryIdAll",
   "availability": "busy",
   "repeat": {},
   "reminder": [],
   "privacy": "private",
   "recurrenceId": null,
   "participants": [
   "originalEvent": null,
   "description": null,
   "calendar": "http://localhost:8080/rest/private/v1/calendar/calendars/john-defaultCalendarId",
   "subject": "event123",
   "location": null,
   "priority": "none",
   "href": "http://localhost:8080/rest/private/v1/calendar/events/Eventa9c5b87b7f00010178ce661a6beb020d",
   "id": "Eventa9c5b87b7f00010178ce661a6beb020d"

Copyright ©2018. All rights reserved. eXo Platform SAS
blog comments powered byDisqus