HTTP API

Reference

Calendar API

Endpoints for bookings, vacations and vacation requests, and the working calendar of work schedules and holidays.

This group covers bookings guests made through booking pages, the caller's vacations and vacation requests, and the workspace's working calendar of work schedules and holidays. Every call acts as a person: send a personal access token, or an OAuth access token from a person's sign-in (scope Volobox). An integration app's own client secret is refused with 403 (Volobox:Integrations:MemberConnectionRequired). Paths, tokens and conventions are in API overview.

Bookings

GET/api/v1/booking
Lists the bookings the caller hosts or may see, one page at a time.
calendar.booking.getList
GET/api/v1/booking/{id}
Gets a booking the caller hosts or may see.
calendar.booking.get
POST/api/v1/booking/{id}/cancel
Cancels a booking and tells the guest, with an optional reason.
calendar.booking.cancel
POST/api/v1/booking/{id}/hand-over
Hands a booking over to another host of its booking page.
calendar.booking.handOver
POST/api/v1/booking/{id}/no-show
Marks that the guest of a booking did not show up.
calendar.booking.markNoShow
GET/api/v1/booking/by-meeting/{meetingId}
Gets the booking behind a meeting, or nothing when the meeting was not booked.
calendar.booking.findByMeeting

Vacations

GET/api/v1/vacation
Lists the caller's own vacations in a date range, with their pending new requests.
calendar.vacation.getList
POST/api/v1/vacation
Books time off for the caller, or submits it for approval while approval is required.
calendar.vacation.create
GET/api/v1/vacation/{id}
Gets one of the caller's own vacations.
calendar.vacation.get
PUT/api/v1/vacation/{id}
Changes the caller's vacation, or asks for the change while approval is required.
calendar.vacation.update
POST/api/v1/vacation/{id}/cancel
Cancels the caller's vacation, or asks for it to be cancelled while approval is required.
calendar.vacation.cancel
GET/api/v1/vacation/all
Lists the approved vacations of everyone in the workspace that overlap a date range.
calendar.vacation.getAllList
GET/api/v1/vacation/upcoming/{userId}
Gets a person's current or next vacation within the next 30 days, or nothing.
calendar.vacation.getUpcomingForUser

Request bodies:

  • CreateVacationDto (create): requires endTime (date-time), startTime (date-time), typeId (uuid).
  • UpdateVacationDto (update): requires endTime (date-time), startTime (date-time), typeId (uuid).

Vacation requests

PUT/api/v1/vacation-request/{id}
Changes the caller's own pending vacation request.
calendar.vacationRequest.update
POST/api/v1/vacation-request/{id}/withdraw
Takes back the caller's own pending vacation request.
calendar.vacationRequest.withdraw
GET/api/v1/vacation-request/mine
Lists the caller's own vacation requests, one page at a time.
calendar.vacationRequest.getMine

Request bodies:

  • UpdateVacationRequestDto (update): requires endTime (date-time), expectedRevision (integer), startTime (date-time), typeId (uuid).

Working calendar

GET/api/v1/working-calendar/holidays
Lists the holidays of a year, optionally for one country.
calendar.workingCalendar.getHolidays
POST/api/v1/working-calendar/holidays
Adds a holiday, for working calendar managers.
calendar.workingCalendar.createHoliday
PUT/api/v1/working-calendar/holidays/{id}
Changes a holiday, for working calendar managers.
calendar.workingCalendar.updateHoliday
DELETE/api/v1/working-calendar/holidays/{id}
Deletes a holiday, for working calendar managers.
calendar.workingCalendar.deleteHoliday
POST/api/v1/working-calendar/holidays/import
Imports a country's public holidays for a year, for working calendar managers.
calendar.workingCalendar.importHolidays
GET/api/v1/working-calendar/schedules
Lists the workspace's work schedules.
calendar.workingCalendar.getSchedules
POST/api/v1/working-calendar/schedules
Creates a work schedule, for working calendar managers.
calendar.workingCalendar.createSchedule
PUT/api/v1/working-calendar/schedules/{id}
Changes a work schedule, for working calendar managers.
calendar.workingCalendar.updateSchedule
DELETE/api/v1/working-calendar/schedules/{id}
Deletes a work schedule, for working calendar managers.
calendar.workingCalendar.deleteSchedule
POST/api/v1/working-calendar/schedules/{id}/default
Makes a work schedule the workspace's default, for working calendar managers.
calendar.workingCalendar.setDefaultSchedule
GET/api/v1/working-calendar/schedules/selectable
Lists the work schedules a person may choose for themselves.
calendar.workingCalendar.getSelectableSchedules

Request bodies:

  • CreateUpdateHolidayDto (createHoliday, updateHoliday): requires countryCode (string), name (string).
  • CreateUpdateWorkScheduleDto (createSchedule, updateSchedule): requires name (string).

Example

calendar.vacationRequest.getMine: lists the caller's own vacation requests, one page at a time.

curl
curl -s "https://volobox.example.com/api/v1/vacation-request/mine?SkipCount=0&MaxResultCount=20" \
  -H "Authorization: Bearer $VOLOBOX_TOKEN"

SkipCount is how many items to skip and MaxResultCount how many to return. The answer carries totalCount and the page of items.