API V1 gives you XML and JSON functions at api.beds24.com to read and write bookings, prices, inventory and property setup. It is deprecated and won't be developed further: for new projects, use API V2.
Allow API access
- Go to Settings > Account > Account Access and allow API access.
- For the JSON functions, set the API key in Settings > Account and the prop key in Settings > Properties > Access. You set both keys yourself.
- The XML functions are accessed with your Beds24 username and password.
- The JSON functions use the API key and prop key. See JSON API Methods.
Usage limits
The default limit is 60 API calls per 5 minutes for an account. Design your interface to eliminate unnecessary calls. With a delay of 5 seconds between calls, you should have no problems.
Capabilities
| Function | What it does |
|---|---|
getBookings |
Returns real-time information about the bookings in the Beds24 system. You can specify a date range. If you don't, the default is from now for 1 year. |
setBookings |
Imports existing bookings up to 2 years back (JSON) or 10 years back (.csv). |
getRates / putRates
|
Downloads Fixed Prices, so you can apply changes and import the changed Fixed Prices (.csv). Uploading changes for linked Fixed Prices isn't possible. |
json/setRoomDates |
Sets daily prices, inventory and minimum stay. The values are sent to all channels that are activated for these values in the control panel. |
getInvoicesCSV |
Gets invoice items as a .csv file. |
getProperty |
Accesses property setup data. |
setProperty |
Manages property setup data. |
getPropertyContent |
Accesses property descriptive content. |
setPropertyContent |
Manages descriptive content and pictures. |
Pictures
- With
setPropertyContentyou can set the URL of external pictures and map them to properties and rooms. - You can't upload to the Beds24 picture hosting via API. Use your own hosting.
- Use JSON
getPropertyContentto see the JSON data structure to send tosetPropertyContent.
API documentation
The documentation is directly in the API at api.beds24.com.
Credit card data
To receive credit card details through the API, your systems must be PCI DSS compliant. Contact Beds24 via a support ticket for further information.
Cancel bookings
You can cancel bookings through the API, but you can't delete them.