Docs/Knowledge Base/PMS Guides

Hostaway API

Hostaway exposes a REST Public API at api.hostaway.com/v1 covering listings, reservations, calendar, conversations, reviews, tasks and unified webhooks, authenticated with OAuth2 client credentials made from an account ID and an API key.

Written from running this integration in production. Last checked against the Hostaway API on 11 November 2026.

Hostaway API report card

From Hostaway's own documentation. Checked on 11 November 2026.

Base URL / API style
https://api.hostaway.com/v1. REST, JSON over HTTPS. Booleans are integers 0 or 1; times are UTC except listing check-in and check-out. source
Auth
OAuth2 client credentials: account ID as client_id, API key as client_secret, scope=general. The token is valid for up to 24 months. source
Rate limits
200 requests / 10 s per account and 200 / 10 s per IP, sliding window. Own limits: send message 30 / min, price calculation 400 / 10 s, create reservation 200 / 10 s. A 429 carries X-RateLimit-Retry-After (a Unix timestamp). source
Webhooks
Unified webhooks to one URL: reservation created, reservation updated, new message received. Optional basic auth; no payload signature. Up to 3 retries within about an hour on 5xx, 429 or network errors; disabled after 5 consecutive days of failures. source
Read / write coverage
Read and write listings, reservations, calendar, tasks, expenses and offline charges; read conversations, reviews and owner statements; respond to reviews. Bookings can be created only on the direct, Vrbo and partner channels. source
Guest messaging
Send on the booking’s channel, email, SMS or WhatsApp (communicationType, default email). No attachments. 30 messages a minute per account. source
Sandbox / test account
Not documented.
Partner / marketplace programme
Hostaway Partner Program: apply, review by the partnerships team, build, then Partner Certification. A Marketplace listing may follow. source
Restrictions worth knowing
Hostaway’s terms (section 9, API) license the API for integrating the customer’s own systems and say the customer “must not surpass rate limits or use the API for competing services”. source

What the Hostaway API is

Hostaway’s Public API is a JSON REST API at https://api.hostaway.com/v1. It covers most of the product: listings, reservations, the calendar, conversations and guest messages, reviews, tasks, owner statements, guest charges and webhooks. You can create and change direct bookings, write nightly prices and stay restrictions, and message a guest on the booking’s channel, by email, SMS or WhatsApp.

Access is self-serve for an account holder. The account ID and an API key from the dashboard are the OAuth2 client credentials, and the token they buy lasts up to 24 months. Software companies that want a Marketplace listing apply to the Hostaway Partner Program and pass its certification, a separate track from creating a key.

Most responses share one envelope: { "status": "success" | "fail", "result": ... }. Read status, not only the HTTP code. The rest of this page is the list of details like that one.

How to get Hostaway API access

  1. 1.In the Hostaway dashboard, open Settings → Hostaway API and click Create.
  2. 2.Name the key and choose the partner it is for, or the generic Hostaway Public API option when the software is not a listed partner. The API key is shown once; copy it before you close the window. Your account ID is shown with it.
  3. 3.Exchange them for a token with POST /accessTokens on https://api.hostaway.com/v1, form-encoded, with grant_type=client_credentials, client_id=<account ID>, client_secret=<API key> and scope=general.
  4. 4.Call the API with Authorization: Bearer <token>. Store the token where every process can reach it: it is valid for up to 24 months, and Hostaway asks you not to generate one per request.

If the account has the Public API switched off, calls answer 403 "Public api is disabled", the token request included. No retry fixes it; the account holder has to turn it back on in Hostaway.

What will bite you

From running this integration in production and reading the vendor's documentation line by line.

Messages go by email unless you say otherwise

POST /conversations/{id}/messages defaults communicationType to email. Reply to an Airbnb guest without setting communicationType: "channel" and the reply goes to the guest’s email address, not the Airbnb thread. Set it on every send. The API cannot send attachments, and sending has its own limit of 30 messages a minute per account.

A failure can come back as HTTP 200

Hostaway reports errors in the body: status: "fail", with the error text in result or message. Code that only checks the HTTP status records a refused write as done.

An update deletes the fields you leave out

Updating a reservation with price components takes the whole object, and Hostaway documents that fields you do not send are deleted. A listing read without includeResources=1 comes back with empty amenities, bed types and images; write it back unchanged and those are wiped. Read with includeResources=1, merge your change, then write.

Channels are numbers

A reservation names its channel with channelId: 2018 is Airbnb (airbnbOfficial), 2005 Booking.com (bookingcom), 2002 Vrbo (homeaway), 2000 direct. Some older Airbnb bookings carry 2001, which is not in the channel table. Match on the id, not the name. The API creates bookings only on the direct (2000), Vrbo (2002) and partner (2020) channels.

Webhooks: three events, no signature, out of order

Unified webhooks send reservation created, reservation updated and new message received to one URL. Hostaway does not filter them, may send the same change twice, and may deliver a message before the reservation it belongs to. There is no payload signature; you can set a basic-auth login and password. A 5xx, 429 or network error is retried up to three times within about an hour, other 4xx responses are not retried, and an endpoint that keeps failing for five consecutive days is disabled.

The 429 header is a timestamp, not a delay

The general limit is 200 requests per 10 seconds per account and per IP, over a sliding window. A 429 carries X-RateLimit-Retry-After, which holds a Unix timestamp in seconds. Read it as a number of seconds to wait and you either sleep for decades or retry at once. Reservation lists page with afterId; offset is deprecated and slows down on large accounts.

What it costs to keep working

Hostaway is one of the easier PMS APIs to start on: the token lasts two years and the limits are generous. What costs time later is keeping up with the details.

  • •The changelog moves. Between August and November 2026 Hostaway changed the reservation object, the listing write rules, the rate limits and the review endpoints. Someone has to read it and act on it.
  • •Webhook handling: deduplicate, tolerate events out of order, and return an error for an event that refers to something you have not seen yet, so Hostaway retries it.
  • •Every write that sends an object back needs a read-merge-write step so it does not delete fields.
  • •Credentials are per account: an account ID and API key per client, each a secret you store and rotate, and a token to replace when it expires or is revoked.
  • •A host can switch the Public API off. On your side it looks like an outage until someone reads the 403.

The same job, both ways

Hostaway directly

HOSTAWAY=https://api.hostaway.com/v1

# Get a token (form-encoded; the account ID is the client_id).
# Store it: it lasts up to 24 months.
curl -s -X POST "$HOSTAWAY/accessTokens" \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'grant_type=client_credentials&client_id=YOUR_ACCOUNT_ID&client_secret=YOUR_API_KEY&scope=general'

# Read reservations, with the attached objects filled in.
curl -s "$HOSTAWAY/reservations?limit=100&includeResources=1" \
  -H 'Authorization: Bearer <token>'

# Reply on the booking's own channel.
# Leave out communicationType and it is sent by email.
curl -s -X POST "$HOSTAWAY/conversations/CONVERSATION_ID/messages" \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"body": "Your door code is ready.", "communicationType": "channel"}'

Through Repull

# Connect once, with the same account ID and API key.
curl -s -X POST 'https://api.repull.dev/v1/connect/hostaway/credentials' \
  -H 'Authorization: Bearer sk_live_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"credentials": {"clientId": "YOUR_ACCOUNT_ID", "clientSecret": "YOUR_API_KEY"}}'

# Reservations from every connected PMS and channel, in one shape.
curl -s 'https://api.repull.dev/v1/reservations?limit=100' \
  -H 'Authorization: Bearer sk_live_YOUR_KEY'

# Reply. Sent on the booking's own channel by default.
curl -s -X POST 'https://api.repull.dev/v1/conversations/CONVERSATION_ID/messages' \
  -H 'Authorization: Bearer sk_live_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"message": "Your door code is ready."}'

Why use Repull for Hostaway

Your second client will not be on Hostaway

If you build for one Hostaway account and always will, use the Public API directly. It is well documented, and Repull would be a layer you do not need. The cost arrives with the second system, or with a client who has no PMS at all.

One reservation shape across every system

A Hostaway reservation, a Guesty one and a Cloudbeds one come back from GET /v1/reservations with the same fields, money broken down the same way. platform says which channel each came from, so you do not keep a table of channel ids per PMS.

Every system authenticates differently

Hostaway is a client-credentials token that lasts two years. Guesty allows five tokens a day. Hospitable is OAuth with 12-hour tokens, or a personal token that lasts a year. Cloudbeds is an API key that expires after 30 days without use. Repull holds and refreshes each of them; you keep one key.

Refused writes are refused before anything is sent

Where Hostaway’s API cannot do something, such as answering a request to book, pre-approving an inquiry, creating a guest record or sending an attachment, Repull answers 422 pms_write_unsupported naming Hostaway, and capabilities.pms on the connection tells you in advance.

One signed webhook stream

Hostaway webhooks carry optional basic auth, Guesty signs through Svix, Cloudbeds sends a header you choose. Repull sends its own events for every connected account with one X-Repull-Signature header to verify.

Channels next to the PMS

Some clients run on an Airbnb account and a spreadsheet. The same Repull key connects Airbnb, Booking.com and Vrbo directly, and more, alongside Hostaway accounts.

Connect Hostaway through Repull

Create a key, connect a Hostaway account with the credentials Hostaway issues, and read reservations in the same shape as every other system you support.

Frequently asked questions

Does Hostaway have a public API?

Yes. The Hostaway Public API is a REST API at https://api.hostaway.com/v1 covering listings, reservations, calendar, conversations, reviews, tasks, guest charges and webhooks. An account holder creates the API key in Settings → Hostaway API; no partner application is needed to use it on your own account.

How do I get Hostaway API credentials?

In Hostaway, open Settings → Hostaway API and click Create. You get your account ID and an API key, shown once. Exchange them with POST /accessTokens on https://api.hostaway.com/v1, using grant_type=client_credentials and scope=general, the account ID as client_id and the key as client_secret. The token lasts up to 24 months.

What are the Hostaway API rate limits?

200 requests per 10 seconds per account, and 200 per 10 seconds per IP address, over a sliding window. Sending a conversation message has its own limit of 30 per minute, the price calculator 400 per 10 seconds and creating a reservation 200 per 10 seconds. A 429 carries X-RateLimit-Retry-After as a Unix timestamp. Enterprise customers can ask support for higher limits.

Does Hostaway have webhooks?

Yes. Unified webhooks deliver reservation created, reservation updated and new message received to one URL, with optional basic auth and no payload signature. Failed deliveries on 5xx, 429 or network errors are retried up to three times within about an hour; an endpoint failing for five consecutive days is disabled.

Why did my Hostaway message go to the guest’s email instead of Airbnb?

Because communicationType defaults to email on POST /conversations/{id}/messages. Send communicationType: "channel" to reply on the booking’s own channel, or sms or whatsapp.

Does Hostaway have a sandbox?

The Hostaway API reference does not document a sandbox or test account. Companies that join the Hostaway Partner Program go through a certification step before a Marketplace listing.

Can I use Hostaway and Repull together?

Yes. Repull connects with the same account ID and API key you would use yourself, so nothing changes inside Hostaway. You read through Repull’s unified schema and can still call Hostaway directly for anything Hostaway-specific.

The other systems Repull connects

What you can do with Hostaway through Repull

Verified against vendor documentation Checked against the Hostaway API reference on 11 November 2026; not yet run against a live account.

Reading listings, reservations, the calendar and conversations works as on every system. These are the writes that go into Hostaway. A refused operation is refused because Hostaway's API cannot do it: the call answers 422 pms_write_unsupported naming Hostaway, and nothing is sent. Read capabilities.pms on GET /v1/connect/hostaway or GET /v1/listings/{id} to know before you call. Bookings are covered in PMS reservation support; how each write is routed is in Writing through a PMS.

WhatCallHostawayNotes
Read reviewsGET /v1/reviewsSupportedSubmitted and published reviews, guest-to-host and host-to-guest, with the 0–10 rating, public text, private feedback and the host response. Each carries pms: "hostaway".
Reply to a reviewPOST /v1/reviews/{id}/replyRefusedHostaway documents a review response (POST /reviews/{id}/respond, Airbnb, Booking.com and Vrbo reviews), but Repull does not send replies through it yet. Refused with pms_write_unsupported — reply in Hostaway or on the channel.
Accept or decline a booking requestPOST /v1/reservations/{id}/accept · /declineRefusedHostaway has no API to answer a request to book. Refused — answer it in Hostaway.
Pre-approve an inquiryPOST /v1/conversations/{id}/pre-approvalRefusedHostaway has no pre-approval API; “pre-approved” is a status it reports, not one you can set. Refused — pre-approve in Hostaway.
Title, descriptions, check-in/out times, capacity, addressPUT /v1/listings/{id}/contentSupportedWritten to Hostaway first, then kept in Repull. Check-in and check-out are whole hours and bathrooms whole numbers; a second street line is refused. Hostaway keeps one language per listing.
Amenities and house rulesPUT /v1/listings/{id}/contentPartlyAmenities: a full replacement, matched to Hostaway’s amenity names. House-rule switches (pets, smoking, events, children allowed) are refused — Hostaway’s listing has no such fields, only maximum pet and child counts.
PhotosPUT /v1/listings/{id}/contentSupportedAdd by URL (send photosMode: "append"; Hostaway processes new photos in the background), delete, reorder and recaption.
Create a guestPOST /v1/guests with providerRefusedHostaway has no guest records: a guest’s details live on the reservation. Refused — create the guest in Repull without provider, or change the booking’s guest with PATCH /v1/reservations/{id}.
Update a guestPATCH /v1/guests/{id}RefusedNo guest records in Hostaway’s API. Refused for a guest linked to Hostaway; change the guest on a direct booking with PATCH /v1/reservations/{id} instead.
Send a messagePOST /v1/conversations/{id}/messagesSupportedSent through Hostaway on the booking’s own channel by default.
Choose the channelchannel on POST /v1/conversations/{id}/messagesSupportedchannel (the booking’s channel), email, sms or whatsapp. Repull’s airbnb, booking, vrbo and expedia are accepted only when the booking is on that channel — Hostaway can only message on the booking’s own channel.
Send attachmentsattachments on POST /v1/conversations/{id}/messagesRefusedHostaway’s API does not send attachments. A message carrying attachments is refused and nothing is sent.
Calendar: open/close nights, nightly price, minimum stayPUT /v1/availability/{propertyId}SupportedOff until you turn it on for the connection with the write policy (calendar.availability, calendar.rates, calendar.restrictions). Sent in batches of up to 200 date ranges. Bookings never push to Hostaway: it blocks its own booked nights.

Reference

Auth Type

OAuth2 Client Credentials

Required Fields

clientIdclientSecret

Supported Operations

✓ listings
✓ reservations
✓ calendar
✓ messages
✓ webhooks
✓ guests

Connection Guide

In Hostaway, open Settings → Hostaway API (turn the Public API on if it is off) and create an API key. Send your Hostaway Account ID as clientId and the API key as clientSecret.

Notes

  • • Tokens last up to 24 months — store one, do not mint per request
  • • Rate limit: 200 requests per 10 seconds per account and per IP; sending a message is 30 per minute
  • • Supports custom variables import
  • • The Public API must be turned on in Hostaway; while it is off every call is refused and the connection asks to be reconnected
  • • Channel mapping available (Airbnb, Booking.com, Vrbo and other channel sources)
AI