API - Reservations

The Pinpoint Booking System API works on a key system to control access. Each user has his own unique API key.

  1. Parameters
  2. Response details
  3. Response example

Parameters

Parameters list
Parameter Description Default Value
calendar_id The list of calendars' IDs for which the reservations will be returned. If the parameter is not given, a search will be conducted in all calendars belonging to a particular user. A list of IDs separated by commas or a single ID.

Example: 1,2,3
start_date Select the day from where returned reservations start. If the parameter is empty, all reservations that are still available today will be returned. The date in YYYY-MM-DD format.

Example: 2015-09-15
end_date Select the day where returned reservations end. If the parameter is empty, all reservations that have the end date after today will be returned. The date in YYYY-MM-DD format.

Example: 2016-09-15
start_hour Select the hour from where returned reservations start. The start hour is 00:00. The time in HH:MM format.

Example: 12:15
end_hour Select the hour where returned reservations end. The end hour is 24:00. The time in HH:MM format.

Example: 20:00
status Return reservations with selected status. As default, all reservations are returned except expired ones. A list of statuses separated by commas or a single status.

Values:
  • pending
  • approved
  • rejected
  • canceled
  • expired
Example: canceled,rejected
payment_methods Return reservations with selected payment methods. If no payment method is set, the parameter will be omitted in search. A list of payment methods separated by commas or a single payment method.

Values:
  • none (will return the reservations with no payment)
  • default (will return the reservations that will be paid on arrival)
  • woocommerce (will return the reservations that were paid via WooCommerce)
  • paypal (will return the reservations paid with PayPal)
Example: none,default,woocommerce
search The value that will be searched in reservations' data. If the parameter is empty or it is not set, no search will be performed. You can send any string to search in:
  • reservations IDs
  • transactions IDs
  • forms data
page Select returned reservations page. First page will be returned by default. Set the page number which you want to be returned.

Example: 2
per_page Select the number of reservations which will be returned. By default, 10 reservations are returned on API call. Set the number of reservations per page that will be returned.

Example: 25
order Order the returned reservations ascending or descending. Reservations are ordered ascending by default. Values:
  • ASC (ascending)
  • DESC (descending)
order_by Select the field after which the reservations will be sorted. By default the reservations are ordered by check_in (start date). Values:
  • check_in (reservation start date)
  • check_out (reservation end date)
  • start_hour (reservation start hour)
  • end_hour (reservation end hour)
  • id (reservation ID)
  • status (reservation status)
  • date_created (reservation request date)