GET /v1/calendar/events/{id}/invitations/

Returns invitations of an event specified by id when: the authenticated user is the participant of the invitation, OR the authenticated user has edit permission on the calendar of the event.



Supported Format: JSON


  • Required (path parameters):

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

Parameter Description
offset The starting point when paging the result. Default is 0.
limit Maximum number of invitations returned. If omitted or exceeds the query limit parameter configured for the class, query limit is used instead.
returnSize Default is false. If set to true, the total number of matched invitations will be returned in JSON, and a "Link" header is added. This header contains "first", "last", "next" and "previous" links.
status Filter the invitations by this status if specified.
fields Comma-separated list of selective invitation attributes to be returned. All returned if not specified.
jsonp The name of a JavaScript function to be used as the JSONP callback. If not specified, only JSON object is returned.
expand Use expand=event to get more event attributes instead of only link.

Request example:

 GET: http://localhost:8080/rest/private/v1/calendar/events/evt123/invitations


   "limit": 10,
   "data": [
       "participant": "john",
       "event": "http://localhost:8080/rest/private/v1/calendar/events/Event9b014f9e7f00010166296f35cf2af06b",
       "status": "",
       "href": "http://localhost:8080/rest/private/v1/calendar/invitations/Event9b014f9e7f00010166296f35cf2af06b:john",
       "id": "Event9b014f9e7f00010166296f35cf2af06b:john"
       "participant": "root",
       "event": "http://localhost:8080/rest/private/v1/calendar/events/Event9b014f9e7f00010166296f35cf2af06b",
       "status": "",
       "href": "http://localhost:8080/rest/private/v1/calendar/invitations/Event9b014f9e7f00010166296f35cf2af06b:root",
       "id": "Event9b014f9e7f00010166296f35cf2af06b:root"
   "size": -1,
   "offset": 0

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