API reference
SupportSign in to Admin

Group owner

In a booking where a number of seats are bookable, like in a seats in a class. Group_owner is the main booking, specifying when the class takes place. The group_customer graph is for handling each seat-booking.

For a complete tutorial on group bookings, please refer to this article in our help center: http://help.timekit.io/working-with-the-api/bookings/group-bookings

One special setting is important when creating a group_owner booking and that is the max_seats setting. This setting specifies the available number of seats.

This example creates a lecture class with 20 seats available.

curl --request POST \
     --url https://api.timekit.io/v2/bookings \
     --header 'Content-Type: application/json' \
     --user :live_api_key_7nzvc7wsBQQISLeFSVhROys9V1bUJ1z7
     --data '{
          "resource_id": "d187d6e0-d6cb-409a-ae60-45a8fd0ec879"
          "graph": "group_owner",
          "action": "create",
          "settings": {
            "max_seats": 20,
            "min_cancel_time": "1 day",
            "min_booking_time": "2 hours",
            "max_booking_time": "14 days"
          },
          "start": "2016-09-30T08:00:00+00:00",
          "end": "2016-09-30T09:00:00+00:00",
          "what": "Doc Brown's lecture on flox capacitance",
          "where": "Sesame St, Middleburg, FL 32068, USA",
          "calendar_id": "bfa0b9fa-36aa-4ae6-8096-f3b20fbed1d2",
          "description": "Please arrive 10 minutes before classes begin"
        }'

The extra settings like "min_cancel_time" are optional, but this is their meaning:

min_cancel_time: Specifies the time cancellation can be done in relation to event begin time. In the example, any cancelation may be done at least 1 day/24 hours before the event starts.
min_booking_time: Specifies the minimum time that the booking must be created, before the event starts. In the example, any bookings must be created 2 hours before the event starts.
max_booking_time: Specifies the maximum time that the booking must be before the event starts. In the example, the bookings can first be created 14 days before event start.

Available actions

  • create ➡️ state: tentative

When in tentative state

  • cancel ➡️ state: cancelled
  • complete ➡️ state: completed

Possible states

  • tentative
  • cancelled
  • completed
  • error