From Booking Automation Wiki
Jump to: navigation, search
This page lists the available APIs and gives general information on how to use them. 

Use of the API

The API functions are available at

To use the API you need to allow API ACCESS. Go to SETTINGS -> ACCOUNT -> ACCOUNT ACCESS and allow API access. The API is available at

  • The XML functions can be accessed with your BookingAutomation username and password.
  • The JSON functions can be created with a API and prop key which you set yourself in the BookingAutomation control panel {#fas:cog}} (SETTINGS)ACCOUNT and {{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS

The default limit is 60 API calls per 5 minutes for an account.

You should design your interface to eliminate unnecessary calls.

If you put a delay of 5 seconds between calls you should have no problems.



  • getBookings will return the real time information about the bookings which are in the BookingAutomation system.
  • You can specify a date range. If you do not, the default is to return from now for 1 year.


  • You can import existing bookings up to 2 years back (json)/10 years back (.csv).


  • You can download rates apply changes and import the changed rates (.csv).

Uploading changes for linked rates is not possible.


  • sets daily prices and inventory and min stay

The values will be sent to all channels which are activated for these values in the control panel.


  • gets invoice items as a .csv file


  • access property setup data


  • manage property setup data


  • access property descriptive content


  • manage descriptive content and pictures

For pictures you can set the URL to external pictures and you can map these to properties and rooms.

You cannot upload to our picture hosting via API, you must use your own hosting.

Use JSON getPropertyContent to see the JSON data structure required to be sent to setPropertyContent.


I cannot get property key?

In Setting > Account > Account Access, make sure API Access Is set to "Allow White List IP Only" and IP Whitelist is set to

Where can I find the API documentation?

The documentation can be found directly in the API.

What do I need to do to receive credit card details though the API?

Your system must be PCI DSS compliant to receive credit card data. Please contact via support ticket for further information.

Can I delete bookings though the API?

You can cancel bookings though the API but not delete them.


This category has the following 3 subcategories, out of 3 total.