Bookings API

A booking represents block of time for an event or multiple events. Bookings can have multiple events.

Booking Fields Overview

  • name (required)
  • description - additional information
  • start_date - (mm/dd/yyyy)
  • end_date(mm/dd/yyyy)
  • location_id - the ID of the location for this booking

Booking Show / List Endpoints (JSON | XML schema)

GET /v1/bookings.(xml | json) 

Retrieves a paginated list of bookings (50 per page, use page parameter listed below to iterate over pages).

GET /v1/bookings/{id}.(xml | json) 

Retrieves an booking by its ID.

DELETE /v1/bookings/{id}.(xml | json)

Deletes the booking for the given ID. 

GET /v1/bookings/search.(xml | json)?{search params}

Search for bookings using filtering parameters (listed below). Append parameters together using & (e.g., ?query=kevin&sort_direction=desc&order=created_at).

Search Parameters and values

  • query - searches by name, event names
  • order - created_at, updated_at, name
  • sort_direction - desc, asc
  • location_ids - comma separated list of location ID's
  • booking_start_date - mm/dd/yyyy (also requires end date)
  • booking_end_date - mm/dd/yyyy (also requires start date)
  • booking_created_start_date - mm/dd/yyyy (also requires end date)
  • booking_created_end_date - mm/dd/yyyy (also requires start date)
  • booking_updated_start_date - mm/dd/yyyy (also requires end date)
  • booking_updated_end_date - mm/dd/yyyy (also requires start date)
  • page (1..9999999)

Booking Create/Update Endpoints (JSON | XML schema)

POST /v1/bookings.(xml | json)?booking={booking parameters}

Creates a booking using the passed in booking parameters. Parameters are expected to follow the format listed in the JSON/XML schema above.

POST /v1/bookings/{id}.(xml | json)?booking={booking parameters}

Works just like the create method except you need to pass in the ID of the booking to update.

Have more questions? Submit a request

Comments