Hostaway

App · 25 actions

Run your Hostaway vacation rentals from workflows: book, change and cancel reservations, open or block calendar days and set prices, message guests, manage cleaning and maintenance tasks, record expenses and reply to reviews. Start a workflow when a reservation is booked, changes or is cancelled, a guest arrives, leaves or writes, or a review or task comes in.

Actions

ActionWhat it does
Cancel reservationCancel a reservation.
Create expense or extraRecord money spent on a listing (an expense), such as a repair, or earned from it (an extra), such as a late check-out fee.
Create reservationBook a listing for a guest, such as a direct booking from your own website.
Create taskAdd a task, such as a cleaning or a repair, for a listing or a reservation, given to one of your team.
Delete expense or extraDelete an expense or extra for good.
Delete reservationDelete a reservation from Hostaway for good, such as a test booking.
Delete taskDelete a task for good.
Find conversationsFind guest conversations, for one reservation or the whole account.
Find guestsLook up guests by email or name, with their contact details and reservations.
Find listingsFind listings by name or place, or those free on certain dates.
Find reservationsFind reservations by listing, channel, guest or dates, last changed first.
Find reviewsFind reviews by listing, kind, status, channel, rating or date, newest first.
Find tasksFind tasks by reservation, status, words in them, or when they start or are due.
Get calendarGet a listing's calendar between two days: whether each day can be booked, its price and its stay limits.
Get listingGet a listing's address, capacity, prices, check-in times and links.
Get reservationGet a reservation's guest, listing, dates, price and status.
Get reservation changesGet a reservation's history of changes, newest first: each field that changed, from what to what, when and by whom.
Get taskGet a task's details, with who it is given to and when it is due.
List expenses and extrasList the newest expenses (money spent) and extras (money earned) recorded for owner statements.
List messagesList the messages in a guest conversation.
Respond to reviewPublish your public reply to a guest's review on Airbnb, Booking.com or Vrbo, once it is published there.
Send messageSend a guest a message in their conversation, by email, through the booking channel, by text or on WhatsApp.
Update calendarOpen or block a listing's days, and set their nightly price and stay limits.
Update reservationChange a reservation's dates, guest details, price or notes.
Update taskChange a task, such as marking it completed or giving it to someone else.

Cancel reservation

Cancel a reservation. Hostaway opens its dates again on every channel; the guest's refund follows the channel's own rules.

Inputs

ReservationreservationtextRequired
The reservation's ID, from another Hostaway step or the trigger.
Cancelled bycancelled_bytext
Who is cancelling it.One of: host, guest. Default: host.

Outputs

adultsnumber
How many adults
arrival_datetext
The arrival date (YYYY-MM-DD)
assignee_user_idtext
The Hostaway user it is assigned to
booked_attext
When it was booked (YYYY-MM-DD HH:MM:SS)
cancelled_attext
When it was cancelled; empty if it wasn't
cancelled_bytext
Who cancelled it: host or guest
channeltext
The channel it was booked on, such as Airbnb or Direct
channel_idtext
The channel's ID, such as 2018 for Airbnb
channel_reservation_idtext
Its ID on the channel it came from
check_in_hournumber
The check-in hour (0 to 23), if set
check_out_hournumber
The check-out hour (0 to 23), if set
childrennumber
How many children
confirmation_codetext
The channel's confirmation code, such as Airbnb's
created_attext
When it was added to Hostaway (YYYY-MM-DD HH:MM:SS, UTC)
currencytext
The price's currency, such as USD
departure_datetext
The departure date (YYYY-MM-DD)
door_codetext
The door code for the stay
guest_addresstext
The guest's street address
guest_citytext
The guest's city
guest_countrytext
The guest's country code
guest_emailtext
The guest's email
guest_first_nametext
The guest's first name
guest_last_nametext
The guest's last name
guest_nametext
The guest's full name
guest_notetext
The guest's note
guest_phonetext
The guest's phone number
guest_zip_codetext
The guest's ZIP or postcode
guestsnumber
How many guests in all
host_notetext
The host's note
idtext
The reservation's Hostaway ID
infantsnumber
How many infants
is_paidtrue/false
Whether it is marked paid
listing_idtext
The listing's ID
listing_nametext
The listing's name
nightsnumber
How many nights
petsnumber
How many pets
sourcetext
Where it came from, as the creator set it
statustext
Its status as Hostaway stores it, such as new or cancelled
status_labeltext
Its status in words, such as New or Cancelled
total_pricenumber
The total price
updated_attext
When it last changed (YYYY-MM-DD HH:MM:SS, UTC)
Example output
{
  "adults": 1,
  "arrival_date": "2017-07-15",
  "assignee_user_id": "1",
  "booked_at": "2017-06-10 10:41:10",
  "cancelled_at": "",
  "cancelled_by": "host",
  "channel": "Airbnb",
  "channel_id": "2018",
  "channel_reservation_id": "10450-40160-thread313906227-9586017324",
  "check_in_hour": null,
  "check_out_hour": null,
  "children": null,
  "confirmation_code": "HMP2KQ4B44",
  "created_at": "2017-06-10 10:41:10",
  "currency": "USD",
  "departure_date": "2017-07-16",
  "door_code": "12345",
  "guest_address": "3411 Cedar St",
  "guest_city": "Austin",
  "guest_country": "US",
  "guest_email": "mail@test.com",
  "guest_first_name": "Andrew",
  "guest_last_name": "Peterson",
  "guest_name": "Andrew Peterson",
  "guest_note": "",
  "guest_phone": "+75125551212",
  "guest_zip_code": "TX 78705",
  "guests": 1,
  "host_note": "",
  "id": "13",
  "infants": null,
  "is_paid": false,
  "listing_id": "40160",
  "listing_name": "Property #3 (Beautiful and cozy apartment close to city center)",
  "nights": 1,
  "pets": null,
  "source": "",
  "status": "cancelled",
  "status_label": "Cancelled",
  "total_price": 267,
  "updated_at": "2017-06-10 10:41:10"
}

Create expense or extra

Record money spent on a listing (an expense), such as a repair, or earned from it (an extra), such as a late check-out fee. It shows in owner statements.

Inputs

Typeexpense_typetext
Money spent, or money earned.One of: expense (Expense (money spent)), extra (Extra (money earned)). Default: expense.
AmountamountnumberRequired
How much, such as 120.50.At least 0.
Dateexpense_datedateRequired
The day it was spent or earned.
DescriptiondescriptiontextRequired
What it was for, such as Plumber. At most 255 characters.
Listinglistingtext
The listing it is for.
Reservationreservationtext
The reservation's ID, from another Hostaway step or the trigger.
Categoriescategorieslist
Category names, such as Repairs. A name Hostaway doesn't have yet is added.

Outputs

amountnumber
How much: below zero for an expense, above for an extra
categorieslist
Its categories
created_attext
When it was recorded (YYYY-MM-DD HH:MM:SS)
datetext
The day it was spent or earned (YYYY-MM-DD)
descriptiontext
What it was for
guest_nametext
That reservation's guest
idtext
The expense's ID
listing_idtext
The listing it is for
listing_nametext
The listing's name
reservation_idtext
The reservation it is for
typetext
expense (money spent) or extra (money earned)
Example output
{
  "amount": -555,
  "categories": [],
  "created_at": "2022-10-19 13:44:00",
  "date": "2021-10-21",
  "description": "test",
  "guest_name": "",
  "id": "3",
  "listing_id": "123",
  "listing_name": "",
  "reservation_id": "456",
  "type": "expense"
}

Create reservation

Book a listing for a guest, such as a direct booking from your own website. Hostaway blocks the dates on every channel the listing is on.

Inputs

ListinglistingtextRequired
The listing to book.
Arrival datearrival_datedateRequired
The day the guest arrives.
Departure datedeparture_datedateRequired
The day the guest leaves.
Channelchanneltext
Where the booking came from.One of: 2000 (Direct), 2020 (Partner), 2002 (Vrbo). Default: 2000.
Guest first nameguest_first_nametext
The guest's first name.
Guest last nameguest_last_nametext
The guest's last name.
Guest emailguest_emailtext
The guest's email address.
Guest phoneguest_phonetext
The guest's phone number with its country code, such as +1 512 555 0134.
Guestsguestsnumber
How many guests in all, such as 2.At least 1.
Adultsadultsnumber
How many of them are adults.At least 0.
Childrenchildrennumber
How many of them are children.At least 0.
Infantsinfantsnumber
How many of them are infants.At least 0.
Petspetsnumber
How many pets are coming.At least 0.
Total pricetotal_pricenumber
The stay's total price, such as 450.At least 0.
Currencycurrencytext
The price's three-letter currency code, such as USD. Leave blank for the listing's.
Guest noteguest_notetext
A note from the guest.
Host notehost_notetext
Your own note on the reservation.
Door codedoor_codetext
The door code for this stay.
Allow overbookingallow_overbookingtrue/false
Save it even when the dates are already booked or blocked. Off by default, so Hostaway refuses a clash.Default: false.

Outputs

adultsnumber
How many adults
arrival_datetext
The arrival date (YYYY-MM-DD)
assignee_user_idtext
The Hostaway user it is assigned to
booked_attext
When it was booked (YYYY-MM-DD HH:MM:SS)
cancelled_attext
When it was cancelled; empty if it wasn't
cancelled_bytext
Who cancelled it: host or guest
channeltext
The channel it was booked on, such as Airbnb or Direct
channel_idtext
The channel's ID, such as 2018 for Airbnb
channel_reservation_idtext
Its ID on the channel it came from
check_in_hournumber
The check-in hour (0 to 23), if set
check_out_hournumber
The check-out hour (0 to 23), if set
childrennumber
How many children
confirmation_codetext
The channel's confirmation code, such as Airbnb's
created_attext
When it was added to Hostaway (YYYY-MM-DD HH:MM:SS, UTC)
currencytext
The price's currency, such as USD
departure_datetext
The departure date (YYYY-MM-DD)
door_codetext
The door code for the stay
guest_addresstext
The guest's street address
guest_citytext
The guest's city
guest_countrytext
The guest's country code
guest_emailtext
The guest's email
guest_first_nametext
The guest's first name
guest_last_nametext
The guest's last name
guest_nametext
The guest's full name
guest_notetext
The guest's note
guest_phonetext
The guest's phone number
guest_zip_codetext
The guest's ZIP or postcode
guestsnumber
How many guests in all
host_notetext
The host's note
idtext
The reservation's Hostaway ID
infantsnumber
How many infants
is_paidtrue/false
Whether it is marked paid
listing_idtext
The listing's ID
listing_nametext
The listing's name
nightsnumber
How many nights
petsnumber
How many pets
sourcetext
Where it came from, as the creator set it
statustext
Its status as Hostaway stores it, such as new or cancelled
status_labeltext
Its status in words, such as New or Cancelled
total_pricenumber
The total price
updated_attext
When it last changed (YYYY-MM-DD HH:MM:SS, UTC)
Example output
{
  "adults": 1,
  "arrival_date": "2017-07-15",
  "assignee_user_id": "1",
  "booked_at": "2017-06-10 10:41:10",
  "cancelled_at": "",
  "cancelled_by": "",
  "channel": "Airbnb",
  "channel_id": "2018",
  "channel_reservation_id": "10450-40160-thread313906227-9586017324",
  "check_in_hour": null,
  "check_out_hour": null,
  "children": null,
  "confirmation_code": "HMP2KQ4B44",
  "created_at": "2017-06-10 10:41:10",
  "currency": "USD",
  "departure_date": "2017-07-16",
  "door_code": "12345",
  "guest_address": "3411 Cedar St",
  "guest_city": "Austin",
  "guest_country": "US",
  "guest_email": "mail@test.com",
  "guest_first_name": "Andrew",
  "guest_last_name": "Peterson",
  "guest_name": "Andrew Peterson",
  "guest_note": "",
  "guest_phone": "+75125551212",
  "guest_zip_code": "TX 78705",
  "guests": 1,
  "host_note": "",
  "id": "13",
  "infants": null,
  "is_paid": false,
  "listing_id": "40160",
  "listing_name": "Property #3 (Beautiful and cozy apartment close to city center)",
  "nights": 1,
  "pets": null,
  "source": "",
  "status": "new",
  "status_label": "New",
  "total_price": 267,
  "updated_at": "2017-06-10 10:41:10"
}

Create task

Add a task, such as a cleaning or a repair, for a listing or a reservation, given to one of your team.

Inputs

TitletitletextRequired
What needs doing, such as Clean after check-out.
Descriptiondescriptiontext
More about what to do.
Listinglistingtext
The listing it is for.
Reservationreservationtext
The reservation's ID, from another Hostaway step or the trigger.
Assigneeassigneetext
The Hostaway user who does it.
Startsstarts_atdate and time
When it can start.
Duedue_atdate and time
When it should be done by.
Categoriescategorieslist
What kind of task it is.One or more of: 1 (Cleaning), 2 (Maintenance), 3 (Check-in), 4 (Check-out), 5 (Back office), 6 (Other).
Statusstatustext
Where it stands. Leave blank for Pending.One of: pending, confirmed, inProgress (In progress), completed, cancelled.

Outputs

assignee_nametext
Their name
assignee_user_idtext
The Hostaway user it is given to
categorieslist
Its categories, such as Cleaning
completed_attext
When it was completed
descriptiontext
More about it
due_attext
When it should be done by (YYYY-MM-DD HH:MM:SS, UTC)
idtext
The task's ID
listing_idtext
The listing it is for
listing_nametext
The listing's name
reservation_idtext
The reservation it is for
resolution_notetext
The note left when it was resolved
started_attext
When it was started
starts_attext
When it can start (YYYY-MM-DD HH:MM:SS, UTC)
statustext
Its status as Hostaway stores it: pending, confirmed, inProgress, completed or cancelled
status_labeltext
Its status in words
titletext
What needs doing
Example output
{
  "assignee_name": "",
  "assignee_user_id": "",
  "categories": [],
  "completed_at": "",
  "description": "",
  "due_at": "2023-07-30 00:00:00",
  "id": "1",
  "listing_id": "",
  "listing_name": "",
  "reservation_id": "",
  "resolution_note": "",
  "started_at": "",
  "starts_at": "2023-07-01 00:00:00",
  "status": "pending",
  "status_label": "Pending",
  "title": "Task title"
}

Delete expense or extra

Delete an expense or extra for good.

Inputs

ExpenseexpensetextRequired
The expense or extra's ID, from another Hostaway step or the trigger.

Outputs

deletedtrue/false
Always true once it is gone
idtext
The ID of what was deleted
Example output
{
  "deleted": true,
  "id": "3"
}

Delete reservation

Delete a reservation from Hostaway for good, such as a test booking. To call off a real stay, cancel it instead.

Inputs

ReservationreservationtextRequired
The reservation's ID, from another Hostaway step or the trigger.

Outputs

deletedtrue/false
Always true once it is gone
idtext
The ID of what was deleted
Example output
{
  "deleted": true,
  "id": "13"
}

Delete task

Delete a task for good.

Inputs

TasktasktextRequired
The task's ID, from another Hostaway step or the trigger.

Outputs

deletedtrue/false
Always true once it is gone
idtext
The ID of what was deleted
Example output
{
  "deleted": true,
  "id": "1"
}

Find conversations

Find guest conversations, for one reservation or the whole account.

Inputs

Reservationreservationtext
The reservation's ID, from another Hostaway step or the trigger.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

conversationslist
The conversations found
countnumber
How many are listed
totalnumber
How many match in all
Example output
{
  "conversations": [
    {
      "guest_email": "mail@test.com",
      "guest_name": "John Smith",
      "has_unread_messages": false,
      "id": "1406",
      "last_message_received_at": "",
      "last_message_sent_at": "2018-06-28 11:24:40",
      "listing_id": "40160",
      "listing_name": "Property #3 (Beautiful and cozy apartment close to city center)",
      "reservation_id": "2",
      "type": "host-guest-email"
    }
  ],
  "count": 1,
  "total": 1
}

Find guests

Look up guests by email or name, with their contact details and reservations. Give at least one.

Inputs

Emailemailtext
The guest's email address.
Namenametext
Words in the guest's name, such as Peterson.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many guests were found
guestslist
The guests found
Example output
{
  "count": 1,
  "guests": [
    {
      "address": "3411 Cedar St",
      "city": "Austin",
      "country": "US",
      "email": "mail@test.com",
      "first_name": "Andrew",
      "last_name": "Peterson",
      "latest_arrival_date": "2017-07-15",
      "name": "Andrew Peterson",
      "phone": "+75125551212",
      "reservation_ids": [
        "13"
      ],
      "reservations": 1,
      "zip_code": "TX 78705"
    }
  ]
}

Find listings

Find listings by name or place, or those free on certain dates. Leave every field blank to list them all.

Inputs

Namenametext
Words in the listing's name.
Citycitytext
The listing's city.
Countrycountrytext
The listing's country.
Free fromavailable_fromdate
Only listings free from this day. Give the last day too.
Free untilavailable_todate
Only listings free until this day.
Guestsguestsnumber
Only listings that sleep at least this many.At least 1.
Include archivedinclude_archivedtrue/false
Also list archived listings.Default: false.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
listingslist
The listings found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "listings": [
    {
      "address": "Schulstra\u00dfe 7, Bremerhaven, Bremen 27570, Germany",
      "airbnb_url": "https://www.airbnb.com/rooms/1234567",
      "archived": false,
      "average_review_rating": 9.2,
      "bathrooms": 1,
      "bedrooms": 1,
      "beds": 1,
      "check_in_from_hour": 12,
      "check_in_until_hour": 21,
      "check_out_hour": 11,
      "city": "Bremerhaven",
      "cleaning_fee": 40.32,
      "country": "Germany",
      "country_code": "DE",
      "currency": "USD",
      "description": "In a classic Bremerhaven house we rent out our apartment which has a living room, bed room and is close to all the restaurants and nightlife.",
      "guests_included": 3,
      "id": "40160",
      "internal_name": "Property #3",
      "max_guests": 6,
      "max_nights": 1125,
      "min_nights": 1,
      "name": "Beautiful and cozy apartment close to city center",
      "price": 211.62,
      "room_type": "entire_home",
      "state": "Bremen",
      "street": "Schulstra\u00dfe 7",
      "time_zone": "Europe/Berlin",
      "vrbo_url": "https://www.vrbo.com/1234567",
      "zip_code": "27570"
    }
  ],
  "total": 1
}

Find reservations

Find reservations by listing, channel, guest or dates, last changed first. Leave every field blank to list the latest.

Inputs

Listinglistingtext
Only reservations for this listing.
Channelchanneltext
Only reservations from this channel.One of: 2018 (Airbnb), 2005 (Booking.com), 2002 (Vrbo), 2007 (Expedia), 2022 (Google), 2019 (Marriott), 2000 (Direct), 2013 (Booking engine), 2020 (Partner), 2021 (GDS), and 5 more.
Guest nameguest_nametext
Words in the guest's name, such as Peterson.
Guest emailguest_emailtext
The guest's email address.
Arriving fromarrival_fromdate
Only arrivals on or after this day.
Arriving untilarrival_todate
Only arrivals on or before this day.
Leaving fromdeparture_fromdate
Only departures on or after this day.
Leaving untildeparture_todate
Only departures on or before this day.
Unread messages onlyunread_messages_onlytrue/false
Only reservations with guest messages nobody has read.Default: false.
Orderordertext
Which come first. Leave blank for the last changed first.One of: recentlyChanged (Last changed first), arrivalDate (Arrival, soonest first), arrivalDateDesc (Arrival, latest first), latestActivityDesc (Latest activity first).
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
reservationslist
The reservations found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "reservations": [
    {
      "adults": 1,
      "arrival_date": "2017-07-15",
      "assignee_user_id": "1",
      "booked_at": "2017-06-10 10:41:10",
      "cancelled_at": "",
      "cancelled_by": "",
      "channel": "Airbnb",
      "channel_id": "2018",
      "channel_reservation_id": "10450-40160-thread313906227-9586017324",
      "check_in_hour": null,
      "check_out_hour": null,
      "children": null,
      "confirmation_code": "HMP2KQ4B44",
      "created_at": "2017-06-10 10:41:10",
      "currency": "USD",
      "departure_date": "2017-07-16",
      "door_code": "12345",
      "guest_address": "3411 Cedar St",
      "guest_city": "Austin",
      "guest_country": "US",
      "guest_email": "mail@test.com",
      "guest_first_name": "Andrew",
      "guest_last_name": "Peterson",
      "guest_name": "Andrew Peterson",
      "guest_note": "",
      "guest_phone": "+75125551212",
      "guest_zip_code": "TX 78705",
      "guests": 1,
      "host_note": "",
      "id": "13",
      "infants": null,
      "is_paid": false,
      "listing_id": "40160",
      "listing_name": "Property #3 (Beautiful and cozy apartment close to city center)",
      "nights": 1,
      "pets": null,
      "source": "",
      "status": "new",
      "status_label": "New",
      "total_price": 267,
      "updated_at": "2017-06-10 10:41:10"
    }
  ],
  "total": 1
}

Find reviews

Find reviews by listing, kind, status, channel, rating or date, newest first. Ratings are out of 10.

Inputs

Listingslistingslist
Only reviews of these listings.
Kindreview_typetext
Guests' reviews of you, or yours of them.One of: guest-to-host (Guests' reviews of you), host-to-guest (Your reviews of guests).
Statusesstatuseslist
Only reviews in these statuses.One or more of: published, submitted, scheduled, pending, awaiting, expired.
Channelschannelslist
Only reviews from these channels.One or more of: 2018 (Airbnb), 2005 (Booking.com), 2002 (Vrbo), 2007 (Expedia), 2022 (Google), 2019 (Marriott), 2000 (Direct), 2013 (Booking engine), 2020 (Partner), 2021 (GDS), and 5 more.
Guest nameguest_nametext
Words in the guest's name.
Lowest ratinglowest_ratingnumber
Only reviews rated at least this, from 0 to 10.From 0 to 10.
Highest ratinghighest_ratingnumber
Only reviews rated at most this, from 0 to 10.From 0 to 10.
Written fromsubmitted_fromdate
Only reviews written on or after this day.
Written untilsubmitted_todate
Only reviews written on or before this day.
Your replyhost_replytext
Only reviews you have answered, or only those you haven't.One of: yes (Answered), no (Not answered yet).
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
reviewslist
The reviews found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "reviews": [
    {
      "arrival_date": "2021-05-06",
      "channel": "Booking.com",
      "channel_id": "2005",
      "departure_date": "2021-05-11",
      "guest_name": "Andrew Peterson",
      "host_response": "",
      "id": "1",
      "listing_id": "1",
      "listing_name": "Beautiful and cozy apartment close to city center",
      "private_feedback": "",
      "public_review": "",
      "rating": null,
      "reservation_id": "1",
      "status": "awaiting",
      "type": "guest-to-host"
    }
  ],
  "total": 1
}

Find tasks

Find tasks by reservation, status, words in them, or when they start or are due. Leave every field blank to list the latest.

Inputs

Reservationreservationtext
The reservation's ID, from another Hostaway step or the trigger.
Statusstatustext
Only tasks in this status.One of: pending, confirmed, inProgress (In progress), completed, cancelled.
Wordstexttext
Words in the task, such as cleaning.
Starting fromstarts_fromdate
Only tasks starting on or after this day.
Starting untilstarts_todate
Only tasks starting on or before this day.
Due fromdue_fromdate
Only tasks due on or after this day.
Due untildue_todate
Only tasks due on or before this day.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
taskslist
The tasks found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "tasks": [
    {
      "assignee_name": "",
      "assignee_user_id": "",
      "categories": [],
      "completed_at": "",
      "description": "",
      "due_at": "2023-07-30 00:00:00",
      "id": "1",
      "listing_id": "",
      "listing_name": "",
      "reservation_id": "",
      "resolution_note": "",
      "started_at": "",
      "starts_at": "2023-07-01 00:00:00",
      "status": "pending",
      "status_label": "Pending",
      "title": "Task title"
    }
  ],
  "total": 1
}

Get calendar

Get a listing's calendar between two days: whether each day can be booked, its price and its stay limits.

Inputs

ListinglistingtextRequired
The listing.
Fromstart_datedateRequired
The first day.
Toend_datedateRequired
The last day.

Outputs

available_daysnumber
How many of them can be booked
countnumber
How many days
dayslist
Each day, in order
listing_idtext
The listing's ID
Example output
{
  "available_days": 0,
  "count": 1,
  "days": [
    {
      "available": false,
      "closed_on_arrival": false,
      "closed_on_departure": false,
      "date": "2017-07-15",
      "maximum_stay": 1125,
      "minimum_stay": 1,
      "note": "",
      "price": 225,
      "status": "reserved"
    }
  ],
  "listing_id": "40160"
}

Get listing

Get a listing's address, capacity, prices, check-in times and links.

Inputs

ListinglistingtextRequired
The listing.

Outputs

addresstext
Its full address
airbnb_urltext
Its page on Airbnb
archivedtrue/false
Whether it is archived
average_review_ratingnumber
Its average review rating, 0 to 10
bathroomsnumber
How many bathrooms
bedroomsnumber
How many bedrooms
bedsnumber
How many beds
check_in_from_hournumber
Check-in opens at this hour (0 to 23)
check_in_until_hournumber
Check-in closes at this hour (0 to 23)
check_out_hournumber
Check-out is by this hour (0 to 23)
citytext
Its city
cleaning_feenumber
Its cleaning fee
countrytext
Its country
country_codetext
Its two-letter country code
currencytext
Its currency, such as USD
descriptiontext
Its description
guests_includednumber
How many guests the price includes
idtext
The listing's ID
internal_nametext
Its internal name
max_guestsnumber
How many guests it sleeps
max_nightsnumber
The most nights a stay can be
min_nightsnumber
The fewest nights a stay can be
nametext
Its public name
pricenumber
Its base nightly price
room_typetext
entire_home, private_room or shared_room
statetext
Its state or region
streettext
Its street
time_zonetext
Its time zone, such as Europe/Berlin
vrbo_urltext
Its page on Vrbo
zip_codetext
Its ZIP or postcode
Example output
{
  "address": "Schulstra\u00dfe 7, Bremerhaven, Bremen 27570, Germany",
  "airbnb_url": "https://www.airbnb.com/rooms/1234567",
  "archived": false,
  "average_review_rating": 9.2,
  "bathrooms": 1,
  "bedrooms": 1,
  "beds": 1,
  "check_in_from_hour": 12,
  "check_in_until_hour": 21,
  "check_out_hour": 11,
  "city": "Bremerhaven",
  "cleaning_fee": 40.32,
  "country": "Germany",
  "country_code": "DE",
  "currency": "USD",
  "description": "In a classic Bremerhaven house we rent out our apartment which has a living room, bed room and is close to all the restaurants and nightlife.",
  "guests_included": 3,
  "id": "40160",
  "internal_name": "Property #3",
  "max_guests": 6,
  "max_nights": 1125,
  "min_nights": 1,
  "name": "Beautiful and cozy apartment close to city center",
  "price": 211.62,
  "room_type": "entire_home",
  "state": "Bremen",
  "street": "Schulstra\u00dfe 7",
  "time_zone": "Europe/Berlin",
  "vrbo_url": "https://www.vrbo.com/1234567",
  "zip_code": "27570"
}

Get reservation

Get a reservation's guest, listing, dates, price and status.

Inputs

ReservationreservationtextRequired
The reservation's ID, from another Hostaway step or the trigger.

Outputs

adultsnumber
How many adults
arrival_datetext
The arrival date (YYYY-MM-DD)
assignee_user_idtext
The Hostaway user it is assigned to
booked_attext
When it was booked (YYYY-MM-DD HH:MM:SS)
cancelled_attext
When it was cancelled; empty if it wasn't
cancelled_bytext
Who cancelled it: host or guest
channeltext
The channel it was booked on, such as Airbnb or Direct
channel_idtext
The channel's ID, such as 2018 for Airbnb
channel_reservation_idtext
Its ID on the channel it came from
check_in_hournumber
The check-in hour (0 to 23), if set
check_out_hournumber
The check-out hour (0 to 23), if set
childrennumber
How many children
confirmation_codetext
The channel's confirmation code, such as Airbnb's
created_attext
When it was added to Hostaway (YYYY-MM-DD HH:MM:SS, UTC)
currencytext
The price's currency, such as USD
departure_datetext
The departure date (YYYY-MM-DD)
door_codetext
The door code for the stay
guest_addresstext
The guest's street address
guest_citytext
The guest's city
guest_countrytext
The guest's country code
guest_emailtext
The guest's email
guest_first_nametext
The guest's first name
guest_last_nametext
The guest's last name
guest_nametext
The guest's full name
guest_notetext
The guest's note
guest_phonetext
The guest's phone number
guest_zip_codetext
The guest's ZIP or postcode
guestsnumber
How many guests in all
host_notetext
The host's note
idtext
The reservation's Hostaway ID
infantsnumber
How many infants
is_paidtrue/false
Whether it is marked paid
listing_idtext
The listing's ID
listing_nametext
The listing's name
nightsnumber
How many nights
petsnumber
How many pets
sourcetext
Where it came from, as the creator set it
statustext
Its status as Hostaway stores it, such as new or cancelled
status_labeltext
Its status in words, such as New or Cancelled
total_pricenumber
The total price
updated_attext
When it last changed (YYYY-MM-DD HH:MM:SS, UTC)
Example output
{
  "adults": 1,
  "arrival_date": "2017-07-15",
  "assignee_user_id": "1",
  "booked_at": "2017-06-10 10:41:10",
  "cancelled_at": "",
  "cancelled_by": "",
  "channel": "Airbnb",
  "channel_id": "2018",
  "channel_reservation_id": "10450-40160-thread313906227-9586017324",
  "check_in_hour": null,
  "check_out_hour": null,
  "children": null,
  "confirmation_code": "HMP2KQ4B44",
  "created_at": "2017-06-10 10:41:10",
  "currency": "USD",
  "departure_date": "2017-07-16",
  "door_code": "12345",
  "guest_address": "3411 Cedar St",
  "guest_city": "Austin",
  "guest_country": "US",
  "guest_email": "mail@test.com",
  "guest_first_name": "Andrew",
  "guest_last_name": "Peterson",
  "guest_name": "Andrew Peterson",
  "guest_note": "",
  "guest_phone": "+75125551212",
  "guest_zip_code": "TX 78705",
  "guests": 1,
  "host_note": "",
  "id": "13",
  "infants": null,
  "is_paid": false,
  "listing_id": "40160",
  "listing_name": "Property #3 (Beautiful and cozy apartment close to city center)",
  "nights": 1,
  "pets": null,
  "source": "",
  "status": "new",
  "status_label": "New",
  "total_price": 267,
  "updated_at": "2017-06-10 10:41:10"
}

Get reservation changes

Get a reservation's history of changes, newest first: each field that changed, from what to what, when and by whom.

Inputs

ReservationreservationtextRequired
The reservation's ID, from another Hostaway step or the trigger.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

changeslist
Each change, newest first
countnumber
How many are listed
reservation_idtext
The reservation's ID
totalnumber
How many changes there are in all
Example output
{
  "changes": [
    {
      "changed_at": "2026-08-04 10:00:00",
      "changed_by": "user@example.com",
      "field": "guestFirstName",
      "field_label": "Guest first name",
      "new_value": "Andrew",
      "previous_value": "Andy"
    }
  ],
  "count": 1,
  "reservation_id": "13",
  "total": 1
}

Get task

Get a task's details, with who it is given to and when it is due.

Inputs

TasktasktextRequired
The task's ID, from another Hostaway step or the trigger.

Outputs

assignee_nametext
Their name
assignee_user_idtext
The Hostaway user it is given to
categorieslist
Its categories, such as Cleaning
completed_attext
When it was completed
descriptiontext
More about it
due_attext
When it should be done by (YYYY-MM-DD HH:MM:SS, UTC)
idtext
The task's ID
listing_idtext
The listing it is for
listing_nametext
The listing's name
reservation_idtext
The reservation it is for
resolution_notetext
The note left when it was resolved
started_attext
When it was started
starts_attext
When it can start (YYYY-MM-DD HH:MM:SS, UTC)
statustext
Its status as Hostaway stores it: pending, confirmed, inProgress, completed or cancelled
status_labeltext
Its status in words
titletext
What needs doing
Example output
{
  "assignee_name": "",
  "assignee_user_id": "",
  "categories": [],
  "completed_at": "",
  "description": "",
  "due_at": "2023-07-30 00:00:00",
  "id": "1",
  "listing_id": "",
  "listing_name": "",
  "reservation_id": "",
  "resolution_note": "",
  "started_at": "",
  "starts_at": "2023-07-01 00:00:00",
  "status": "pending",
  "status_label": "Pending",
  "title": "Task title"
}

List expenses and extras

List the newest expenses (money spent) and extras (money earned) recorded for owner statements.

Inputs

How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
expenseslist
The expenses and extras, newest first
Example output
{
  "count": 1,
  "expenses": [
    {
      "amount": -555,
      "categories": [],
      "created_at": "2022-10-19 13:44:00",
      "date": "2021-10-21",
      "description": "test",
      "guest_name": "",
      "id": "3",
      "listing_id": "123",
      "listing_name": "",
      "reservation_id": "456",
      "type": "expense"
    }
  ]
}

List messages

List the messages in a guest conversation.

Inputs

ConversationconversationtextRequired
The conversation's ID, from another Hostaway step or the trigger.
Include scheduledinclude_scheduledtrue/false
Also list messages waiting to go, failed or paused. Off lists only sent ones.Default: false.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

conversation_idtext
The conversation's ID
countnumber
How many are listed
messageslist
The messages
totalnumber
How many messages there are in all
Example output
{
  "conversation_id": "1406",
  "count": 1,
  "messages": [
    {
      "attachment_urls": [
        "https://www.image.com/img.jpeg"
      ],
      "body": "hello guest",
      "conversation_id": "1406",
      "created_at": "2018-07-16 10:12:52",
      "from_guest": false,
      "id": "326",
      "listing_id": "40160",
      "reservation_id": "2",
      "seen": false,
      "sent_at": "2018-07-16 10:13:52",
      "sent_by": "email",
      "status": "sent"
    }
  ],
  "total": 1
}

Respond to review

Publish your public reply to a guest's review on Airbnb, Booking.com or Vrbo, once it is published there. Each review can be answered once.

Inputs

ReviewreviewtextRequired
The review's ID, from another Hostaway step or the trigger.
ReplyresponsetextRequired
Your public reply to the guest.

Outputs

arrival_datetext
The stay's arrival date
channeltext
The channel it is on, such as Airbnb
channel_idtext
The channel's ID
departure_datetext
The stay's departure date
guest_nametext
The guest's name
host_responsetext
Your public reply; empty if none
idtext
The review's ID
listing_idtext
The listing's ID
listing_nametext
The listing's name
private_feedbacktext
The private feedback
public_reviewtext
What it says publicly
ratingnumber
Its rating, 0 to 10
reservation_idtext
The reservation's ID
statustext
published, submitted, scheduled, pending, awaiting or expired
typetext
guest-to-host (a guest's review) or host-to-guest (yours)
Example output
{
  "arrival_date": "2021-05-06",
  "channel": "Booking.com",
  "channel_id": "2005",
  "departure_date": "2021-05-11",
  "guest_name": "Andrew Peterson",
  "host_response": "Thank you for staying with us, we hope to welcome you again.",
  "id": "1",
  "listing_id": "1",
  "listing_name": "Beautiful and cozy apartment close to city center",
  "private_feedback": "",
  "public_review": "",
  "rating": null,
  "reservation_id": "1",
  "status": "published",
  "type": "guest-to-host"
}

Send message

Send a guest a message in their conversation, by email, through the booking channel, by text or on WhatsApp. Hostaway allows 30 a minute.

Inputs

ConversationconversationtextRequired
The conversation's ID, from another Hostaway step or the trigger.
MessagemessagetextRequired
What to send the guest.
Send bysend_bytext
How it reaches the guest.One of: email, channel (Through the booking channel, such as Airbnb), sms (Text message (SMS)), whatsapp. Default: email.

Outputs

attachment_urlslist
Links to its attachments
bodytext
What the message says
conversation_idtext
The conversation's ID
created_attext
When Hostaway recorded it (YYYY-MM-DD HH:MM:SS)
from_guesttrue/false
Whether the guest sent it
idtext
The message's ID
listing_idtext
The listing's ID
reservation_idtext
The reservation's ID
seentrue/false
Whether it has been read
sent_attext
When it was sent (YYYY-MM-DD HH:MM:SS)
sent_bytext
How it was sent: email, channel, sms or whatsapp
statustext
sent, awaiting, failed, paused or cancelled
Example output
{
  "attachment_urls": [
    "https://www.image.com/img.jpeg"
  ],
  "body": "hello guest",
  "conversation_id": "1406",
  "created_at": "2018-07-16 10:12:52",
  "from_guest": false,
  "id": "326",
  "listing_id": "40160",
  "reservation_id": "2",
  "seen": false,
  "sent_at": "2018-07-16 10:13:52",
  "sent_by": "email",
  "status": "sent"
}

Update calendar

Open or block a listing's days, and set their nightly price and stay limits. Hostaway sends the change to every channel the listing is on.

Inputs

ListinglistingtextRequired
The listing.
Fromstart_datedateRequired
The first day to change.
Toend_datedateRequired
The last day to change.
Availabilityavailabilitytext
Open the days for booking, or block them. Leave blank to keep it.One of: available, blocked.
Nightly pricepricenumber
The new price for each night.At least 0.
Minimum stayminimum_staynumber
The fewest nights a stay can be.At least 1.
Maximum staymaximum_staynumber
The most nights a stay can be.At least 1.
Units to sellunits_to_sellnumber
For a listing with several identical units: how many to offer. 0 blocks them all.At least 0.
Notenotetext
A note on the days.

Outputs

countnumber
How many days changed
dayslist
The days changed, as they are now
listing_idtext
The listing's ID
Example output
{
  "count": 1,
  "days": [
    {
      "available": true,
      "closed_on_arrival": false,
      "closed_on_departure": false,
      "date": "2017-09-01",
      "maximum_stay": 1125,
      "minimum_stay": 1,
      "note": "test",
      "price": 20,
      "status": "available"
    }
  ],
  "listing_id": "40160"
}

Update reservation

Change a reservation's dates, guest details, price or notes. Fields left blank keep what they have.

Inputs

ReservationreservationtextRequired
The reservation's ID, from another Hostaway step or the trigger.
Arrival datearrival_datedate
A new arrival day.
Departure datedeparture_datedate
A new departure day.
Guest first nameguest_first_nametext
The guest's first name.
Guest last nameguest_last_nametext
The guest's last name.
Guest emailguest_emailtext
The guest's email address.
Guest phoneguest_phonetext
The guest's phone number with its country code, such as +1 512 555 0134.
Guestsguestsnumber
How many guests in all, such as 2.At least 1.
Adultsadultsnumber
How many of them are adults.At least 0.
Childrenchildrennumber
How many of them are children.At least 0.
Infantsinfantsnumber
How many of them are infants.At least 0.
Petspetsnumber
How many pets are coming.At least 0.
Total pricetotal_pricenumber
The stay's total price, such as 450.At least 0.
Guest noteguest_notetext
A note from the guest.
Host notehost_notetext
Your own note on the reservation.
Door codedoor_codetext
The door code for this stay.
Allow overbookingallow_overbookingtrue/false
Save it even when the dates are already booked or blocked. Off by default, so Hostaway refuses a clash.Default: false.

Outputs

adultsnumber
How many adults
arrival_datetext
The arrival date (YYYY-MM-DD)
assignee_user_idtext
The Hostaway user it is assigned to
booked_attext
When it was booked (YYYY-MM-DD HH:MM:SS)
cancelled_attext
When it was cancelled; empty if it wasn't
cancelled_bytext
Who cancelled it: host or guest
channeltext
The channel it was booked on, such as Airbnb or Direct
channel_idtext
The channel's ID, such as 2018 for Airbnb
channel_reservation_idtext
Its ID on the channel it came from
check_in_hournumber
The check-in hour (0 to 23), if set
check_out_hournumber
The check-out hour (0 to 23), if set
childrennumber
How many children
confirmation_codetext
The channel's confirmation code, such as Airbnb's
created_attext
When it was added to Hostaway (YYYY-MM-DD HH:MM:SS, UTC)
currencytext
The price's currency, such as USD
departure_datetext
The departure date (YYYY-MM-DD)
door_codetext
The door code for the stay
guest_addresstext
The guest's street address
guest_citytext
The guest's city
guest_countrytext
The guest's country code
guest_emailtext
The guest's email
guest_first_nametext
The guest's first name
guest_last_nametext
The guest's last name
guest_nametext
The guest's full name
guest_notetext
The guest's note
guest_phonetext
The guest's phone number
guest_zip_codetext
The guest's ZIP or postcode
guestsnumber
How many guests in all
host_notetext
The host's note
idtext
The reservation's Hostaway ID
infantsnumber
How many infants
is_paidtrue/false
Whether it is marked paid
listing_idtext
The listing's ID
listing_nametext
The listing's name
nightsnumber
How many nights
petsnumber
How many pets
sourcetext
Where it came from, as the creator set it
statustext
Its status as Hostaway stores it, such as new or cancelled
status_labeltext
Its status in words, such as New or Cancelled
total_pricenumber
The total price
updated_attext
When it last changed (YYYY-MM-DD HH:MM:SS, UTC)
Example output
{
  "adults": 1,
  "arrival_date": "2017-07-15",
  "assignee_user_id": "1",
  "booked_at": "2017-06-10 10:41:10",
  "cancelled_at": "",
  "cancelled_by": "",
  "channel": "Airbnb",
  "channel_id": "2018",
  "channel_reservation_id": "10450-40160-thread313906227-9586017324",
  "check_in_hour": null,
  "check_out_hour": null,
  "children": null,
  "confirmation_code": "HMP2KQ4B44",
  "created_at": "2017-06-10 10:41:10",
  "currency": "USD",
  "departure_date": "2017-07-16",
  "door_code": "12345",
  "guest_address": "3411 Cedar St",
  "guest_city": "Austin",
  "guest_country": "US",
  "guest_email": "mail@test.com",
  "guest_first_name": "Andrew",
  "guest_last_name": "Peterson",
  "guest_name": "Andrew Peterson",
  "guest_note": "",
  "guest_phone": "+75125551212",
  "guest_zip_code": "TX 78705",
  "guests": 1,
  "host_note": "",
  "id": "13",
  "infants": null,
  "is_paid": false,
  "listing_id": "40160",
  "listing_name": "Property #3 (Beautiful and cozy apartment close to city center)",
  "nights": 1,
  "pets": null,
  "source": "",
  "status": "new",
  "status_label": "New",
  "total_price": 267,
  "updated_at": "2017-06-10 10:41:10"
}

Update task

Change a task, such as marking it completed or giving it to someone else. Fields left blank keep what they have.

Inputs

TasktasktextRequired
The task's ID, from another Hostaway step or the trigger.
Titletitletext
A new title. Leave blank to keep it.
Descriptiondescriptiontext
More about what to do.
Listinglistingtext
The listing it is for.
Reservationreservationtext
The reservation's ID, from another Hostaway step or the trigger.
Assigneeassigneetext
The Hostaway user who does it.
Startsstarts_atdate and time
When it can start.
Duedue_atdate and time
When it should be done by.
Categoriescategorieslist
What kind of task it is.One or more of: 1 (Cleaning), 2 (Maintenance), 3 (Check-in), 4 (Check-out), 5 (Back office), 6 (Other).
Statusstatustext
Where it stands now, such as Completed.One of: pending, confirmed, inProgress (In progress), completed, cancelled.

Outputs

assignee_nametext
Their name
assignee_user_idtext
The Hostaway user it is given to
categorieslist
Its categories, such as Cleaning
completed_attext
When it was completed
descriptiontext
More about it
due_attext
When it should be done by (YYYY-MM-DD HH:MM:SS, UTC)
idtext
The task's ID
listing_idtext
The listing it is for
listing_nametext
The listing's name
reservation_idtext
The reservation it is for
resolution_notetext
The note left when it was resolved
started_attext
When it was started
starts_attext
When it can start (YYYY-MM-DD HH:MM:SS, UTC)
statustext
Its status as Hostaway stores it: pending, confirmed, inProgress, completed or cancelled
status_labeltext
Its status in words
titletext
What needs doing
Example output
{
  "assignee_name": "",
  "assignee_user_id": "",
  "categories": [],
  "completed_at": "",
  "description": "",
  "due_at": "2023-07-30 00:00:00",
  "id": "1",
  "listing_id": "",
  "listing_name": "",
  "reservation_id": "",
  "resolution_note": "",
  "started_at": "",
  "starts_at": "2023-07-01 00:00:00",
  "status": "pending",
  "status_label": "Pending",
  "title": "Task title"
}

On this page