❗We will be deprecating V1 of our API on February 3rd, 2025. Please refer to the Upgrade Guide for instructions on migrating to V2.
Hospitable's Public API v1 is a legacy version of the API that was designed to give hosts the capabilities they may need to build custom solutions for their unique business needs. This version will be deprecated in favor of Public API v2, however, a deprecation date has not yet been determined.
🚧 Client IDs and Client Secrets give access to your account through a legacy version of Hospitable's Public API. Please read carefully to understand when you should generate Client ID and Client Secret's.
When to use a Client ID and Client Secret
Because Client ID and Client Secret grant access to a legacy version of the API, it is only recommended to generate these to share with integration partners who have not yet upgraded their integration to the current version of our Public API (v2) that supports OAuth. If you are accessing the Public API for personal use, it's best to use a personal access token, and you can learn more about how to do that here.
Generate a Client ID and Client Secret
Log in to my.hospitable.com.
In the sidebar, click 'Apps'.
Choose 'API keys (legacy)' tab.
In the 'API keys (legacy)' tab, click '+ Add new'.
Give your API keys a name.
It's helpful to name the API keys based on your intended use. For example, if you're sharing these with an integration, name it accordingly so you know who you've shared it with.Choose the permissions you'd like to grant for this access token.
Read: read access allows you to view, but not modify, information about your properties, reservations and calendar.
Write: write access allows you to modify your property calendar's pricing and availability.
You can now provide your Client ID and Client Secret to an integration partner, or use it personally to generate a bearer token and access the legacy version of Hospitable's Public API (v1).
⛔ ✉️ It is not secure to share Client IDs and Secrets via email. Only share these securely through the user interface of trusted integration partners who have not yet upgraded to the current version of our Public API (v2) which supports OAuth.
Check out our Public API documentation to learn more about how to access and interact with your account via API.