An API (Application Programming Interface) is a specification for how to talk to another piece of software. We have API connections with Vrbo, Airbnb, and others, where we've written OwnerRez software according to their API specs so we can talk to them. Learn more about API's, channel integrations, and related terms.
OwnerRez itself has an API, which is available to other companies and users who want to communicate with our software. This is how dynamic pricing companies like PriceLabs send rates into your OwnerRez account.
Our API docs are in a state of transition as is the API itself. If you run into problems, contact us directly at partnerhelp@ownerrez.com, and we'll help you out.
Note that the token-based API authentication is intended for private usage, and is not designed for partner use or wide deployment. If you are a partner wishing to offer your services to OwnerRez clients in general, you need to use our more robust and secure OAuth API authentication.
Data Format
Everything is JSON, and requires Content-Type: application/json
and/or Accept: application/json
headers.
Use a user-agent header to identify yourself on all calls. For example: User-Agent: My Acme App
.
Authentication/Authorization
You can either use Personal Access Tokens to access your own account via API or create an OAuth App if you want other users to grant access to their accounts via API. For more info on both methods, see the API Authentication article.
Example API call
A call to lookup property availability via /api/properties/lookup for a user wylie@acme.com
using a Personal Access Token of pt_faaaast
would be something like:
curl -u wylie@acme.com:faaaast -i -X GET https://app.ownerrez.com/api/properties/lookup -H "Content-Type:application/json"
Documentation
- Authentication
- OAuth Apps
- Webhooks
- Rate Limiting
- Creating Quotes and Bookings
- v1.0 Documentation deprecated
- v1.1 Documentation deprecated
- v2.0 Documentation stable