It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Confluence REST API to read Calendar events

I didn't find any official REST API to read calendar events but got to know about an unofficial end point to get event data in one of the discussion thread.

https://stackoverflow.com/questions/44412554/calendar-info-using-confluence-api

https://community.atlassian.com/t5/Answers-Developer-Questions/Team-Calendar-list-events-API/qaq-p/532723

 

End point - https://yourconfluence.com/rest/calendar-services/1.0/calendar/events.json?subCalendarId=40xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&userTimeZoneId=US%2FPacific&start=2019-01-28T00%3A00%3A00Z&end=2019-06-28T00%3A00%3A00Z

 

Curl response I'm getting is {"success":true} but it doesn't have any event list. I did verified date ranges again and again and we have events within input date range.

 

So, is there something I'm doing wrong here? Any pointers? Thanks.

 

3 answers

2 accepted

2 votes
Answer accepted

Hey, just letting you (and anyone who stumbles across this post, like I did) know, the unofficial API is currently working.

I got the same problem as you, and eventually figured out that the cause was the structure of the calendar itself. It appears that Team Calendars stores each calendar as multiple sub-calendars, with each sub-calendar managing a different type of event (e.g. Leave, Travel, etc).

So it's returning success=true because technically that call is doing what it's supposed to: it's just there are no events associated with the derived calendar - which is likely to be the ID you're using - they're all in the sub-calendars.

The way I found to get it working was by using the ID's of the sub-calendars instead. The easiest way I found to figure those out is to go into the network calls. There you should find some number of calls (that correspond to the number of event types of events in that time range) that start like events.json?subCalendarId=<some numbers>. You can copy the URL's of those calls, and they'll give you the sub-calendar ID's and the different API calls you need to make. 

Good luck!

Mark Legg I'm New Here Sep 07, 2020

I was having the same challenge and found rest/calendar-services/1.0/calendar/subcalendars.json? returns all the calenders I am subscribed to parents and all. I then went through the list to get the subcalender IDs and get the events for each sub calender.

1 vote
Answer accepted

Hello Vaibhav and welcome to the Community!

The REST API endpoint you’re using may be responding, but it doesn’t seem to be fully developed as of now. There is a feature request for Confluence Server to have this added under support. You may find that feature request at CONFSERVER-51323. We would suggest you vote and watch this request to receive future updates.

As of now, there is not an available REST API endpoint which will give you access to the calendar events.

Regards,
Stephen Sifers

Thanks Stephen for your response. I will vote for feature request.

Like # people like this

The Simple Solution (But not exactly REST) is to use the iCal export (the subscribe button).  Then use an iCal library to parse the data. 

Suggest an answer

Log in or Sign up to answer
TAGS
Community showcase
Published in Next-gen

Keyboard shortcuts have arrived for next-gen projects!

...ollected feedback from users around the lack of shortcuts, and we’re here to address that: In next-gen projects, I miss the keyboard shortcuts badly. This is particularly true on the Board, but also i...

233 views 2 4
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you