Overview of the LibCal API

To access the API, go to Admin > API.

Navigating to the API page


What is an API?

API stands for Application Programming Interface and it allows you to display and process your LibCal content outside of your system. The LibCal API offers more flexibility than widgets, but they also require more extensive coding knowledge and are more complicated than just copying and pasting.

To think of this in another way, widgets are kind of like a frozen dinner - what you see is what you get. APIs are like individual ingredients. Think of all the different meals a cook can create from the same set of ingredients! APIs offer you the same opportunity to mix & match. The possibilities are almost endless!

The LibCal API is only available with paid subscriptions. If you currently have a free LibCal subscription and would like to explore the API, please contact our Springy Sales Team about increasing your subscription tier.

API v1.0 endpoints

The v1.0 endpoints are the older version of the LibCal API, but are still supported for backwards compatibility. If you are currently using the v1.0 endpoints, you do not need to change your existing scripts. However, we encourage you to use the newer v1.1 endpoints for all future development.

Available endpoints

Full details for using each endpoint are available in LibCal under Admin > API > Endpoints v1.0 -- just click on the endpoint's URL on that page to view its specific documentation. Below is a summary of what's available.

  • Calendars: retrieve information on one or multiple calendars.
  • Events: retrieve information on one or multiple events. You can also search for events, as well.
  • Appointments: retrieve a list of appointments for a specific user.
  • Room Bookings: retrieve information on one or more room groups or individual rooms. You can also retrieve the availability for a single room, as well as the confirmed bookings for a room group.
  • Equipment: retrieve information on locations, booking forms, categories, and items. You can also retrieve a list of overdue items and fines, and you can also cancel equipment bookings.
  • Spaces: retrieve information on locations, booking forms, categories, spaces, and bookings. You can also cancel bookings, as well.

API v1.1 endpoints

The v1.1 endpoints include requests that allow you to get and post data. Before you can begin using them, you must first create an access token for each application you intend to create. You can add a application under the API Authentication tab.

Navigating to the API Authentication page

Once you have your access token, send it via the Authorization header in your request. For example:

POST /1.1/equipment HTTP/1.1
Host: api2.libcal.com
Authorization: Bearer ACCESSTOKEN

Available endpoints

Full details for using each endpoint are available in LibCal under Admin > API > Endpoints v1.1 -- just click on the endpoint's URL on that page to view its specific documentation. Below is a summary of what's available.

  • Calendars: retrieve information on one or multiple calendars.
  • Events: retrieve information on one or multiple events. You can also search for events, as well.
  • Appointments: retrieve a list of appointments for all users or a specific user. You can also retrieve a list of Appointments users, appointment categories, and booking form questions in your system.
  • Room Bookings: retrieve information on one or more room groups or individual rooms. You can also retrieve the availability for a single room, as well as the confirmed bookings for a room group.
  • Equipment: retrieve information on locations, booking forms, categories, and items. You can also retrieve a list of overdue items and fines. In addition, you can also submit and cancel equipment bookings.
  • Spaces: retrieve information on locations, booking forms, categories, spaces, and bookings. You can also submit and cancel bookings, as well.

Related Articles