Skip to main content
Sign in Menu

Hostaway Public API - Account & Secret Key

Florian
  • Updated

Hostaway API key

Hostaway has an API that can be used to manage various functions within the platform. Please refer to our extensive API Documentation if you wish to use it to access Hostaway.

You can activate the API in the Hostaway Dashboard > Settings > Hostaway API

 

How to create a new API key?

To create a new API Key please follow the next steps:

  1. Go to your Hostaway Dashboard > Settings > Hostaway API
  2. Click on Create > Choose a Name and Partner

    Screenshot 2024-07-10 at 13.18.28.png
    • Partner selection is mandatory for generating API keys
    • The list of partners is limited to those displayed in our Dashboard's Marketplace with a connect button

      image (14).png

    • Additionally, you will find under Partner a generic option called Hostaway Public API for software that is not part of our official partners

      image (15).png

  3. Create
  4. The Account ID and the API Key will be presented on a new window

    API secret key generated successfully.png

  5. Save your Account ID and API Key and keep it somewhere safe for later
    • We will only show it once. Save it if you wish to use it for more than one connection
  6. The API key will auto-generate a name with this format: Partner name API Key YYYY-MM-DD

 

Screenshot 2024-07-10 at 13.37.35.png


Very important: The API key should be used to generate the access_token. The generated access_token is valid for a maximum of 24 months. It is recommended to renew the access_token automatically or manually every 12 months. In the event, that the connected application can not renew the access_token a newly generated API key should be used to reconnect the Hostaway account

 

How to rename an API key?

Click on the "..." > Edit

Screenshot 2024-07-10 at 13.36.21.png

 

How to delete an API key?

Click on the "..."  > Delete

Screenshot 2024-07-10 at 13.36.21.png

 

How to revoke a Token?

You will need to click on Revoke access token > Enter the token and click on Revoke

Screenshot 2024-07-10 at 13.41.23.png

 

Important

  • The generated secret API key and the token will only appear one time in the Hostaway Dashboard and expire after 24 months
  • After you have generated it and left the page, it will no longer be visible to you or our support team
  • Store the key at a personal safe location to use it later during your development time
  • If you ever notice a bug, please send us a report submitting a request. The report should include cURL POST request with the endpoint URL, the time of the request with timezone, header, payload, response, and expected result

Related articles