All Collections
Webhooks and API integration
Accessing the Public API with a personal access token
Accessing the Public API with a personal access token

Learn how to generate a personal access token, set permissions and interact with your account programmatically via the Public API.

Emily Tunggala avatar
Written by Emily Tunggala
Updated over a week ago

Hospitable's Public API is designed to give hosts the capabilities they may need to build custom solutions for their unique business needs. Hosts can interact with their own accounts programmatically through the Public API by using a personal access token, otherwise known as a PAT.

πŸ”‘ Personal access tokens, like the name suggests, are for personal access only. Integrating partners are expected to implement OAuth in order to gain authorized access to customer account. Please do not share your personal access token with anybody, even trusted vendors.

Generate a personal access token (PAT)

πŸ”’ Access tokens can be generated by account owners. If you are a secondary user on a Hospitable account, please contact the account owner with your request.

  1. Log in to

  2. In the sidebar, click 'Apps'.

  3. Choose 'API access'.

  4. In the 'Access tokens' tab, click '+ Add new'.

  5. Give your access token a name.
    It's helpful to name the access token based on your intended use. For example, if you're building a custom owner's statement, you may want to name it 'Owner's statement' so you can remember what the token is being used for.

  6. 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.

  7. Provide this token in each request, in an Authorization header with Bearer <token> as the value.

Check out our Public API documentation to learn more about how to access and interact with your account via API.

Personal access tokens give you access to v2 of our Public API. To access v1 of our Public API, you can use Client ID and Client Secrets instead.

Did this answer your question?