# Hostaway

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

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/hostaway

## Actions

### Cancel reservation

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

**Inputs**

- Reservation (`reservation`, text, required): The reservation's ID, from another Hostaway step or the trigger.
- Cancelled by (`cancelled_by`, text): Who is cancelling it. One of: `host`, `guest`. Default: `host`.

**Outputs**

- `adults` (number): How many adults
- `arrival_date` (text): The arrival date (YYYY-MM-DD)
- `assignee_user_id` (text): The Hostaway user it is assigned to
- `booked_at` (text): When it was booked (YYYY-MM-DD HH:MM:SS)
- `cancelled_at` (text): When it was cancelled; empty if it wasn't
- `cancelled_by` (text): Who cancelled it: host or guest
- `channel` (text): The channel it was booked on, such as Airbnb or Direct
- `channel_id` (text): The channel's ID, such as 2018 for Airbnb
- `channel_reservation_id` (text): Its ID on the channel it came from
- `check_in_hour` (number): The check-in hour (0 to 23), if set
- `check_out_hour` (number): The check-out hour (0 to 23), if set
- `children` (number): How many children
- `confirmation_code` (text): The channel's confirmation code, such as Airbnb's
- `created_at` (text): When it was added to Hostaway (YYYY-MM-DD HH:MM:SS, UTC)
- `currency` (text): The price's currency, such as USD
- `departure_date` (text): The departure date (YYYY-MM-DD)
- `door_code` (text): The door code for the stay
- `guest_address` (text): The guest's street address
- `guest_city` (text): The guest's city
- `guest_country` (text): The guest's country code
- `guest_email` (text): The guest's email
- `guest_first_name` (text): The guest's first name
- `guest_last_name` (text): The guest's last name
- `guest_name` (text): The guest's full name
- `guest_note` (text): The guest's note
- `guest_phone` (text): The guest's phone number
- `guest_zip_code` (text): The guest's ZIP or postcode
- `guests` (number): How many guests in all
- `host_note` (text): The host's note
- `id` (text): The reservation's Hostaway ID
- `infants` (number): How many infants
- `is_paid` (true/false): Whether it is marked paid
- `listing_id` (text): The listing's ID
- `listing_name` (text): The listing's name
- `nights` (number): How many nights
- `pets` (number): How many pets
- `source` (text): Where it came from, as the creator set it
- `status` (text): Its status as Hostaway stores it, such as new or cancelled
- `status_label` (text): Its status in words, such as New or Cancelled
- `total_price` (number): The total price
- `updated_at` (text): When it last changed (YYYY-MM-DD HH:MM:SS, UTC)

**Example output**

```json
{
  "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**

- Type (`expense_type`, text): Money spent, or money earned. One of: `expense` (Expense (money spent)), `extra` (Extra (money earned)). Default: `expense`.
- Amount (`amount`, number, required): How much, such as 120.50. At least 0.
- Date (`expense_date`, date, required): The day it was spent or earned.
- Description (`description`, text, required): What it was for, such as Plumber. At most 255 characters.
- Listing (`listing`, text): The listing it is for.
- Reservation (`reservation`, text): The reservation's ID, from another Hostaway step or the trigger.
- Categories (`categories`, list): Category names, such as Repairs. A name Hostaway doesn't have yet is added.

**Outputs**

- `amount` (number): How much: below zero for an expense, above for an extra
- `categories` (list): Its categories
- `created_at` (text): When it was recorded (YYYY-MM-DD HH:MM:SS)
- `date` (text): The day it was spent or earned (YYYY-MM-DD)
- `description` (text): What it was for
- `guest_name` (text): That reservation's guest
- `id` (text): The expense's ID
- `listing_id` (text): The listing it is for
- `listing_name` (text): The listing's name
- `reservation_id` (text): The reservation it is for
- `type` (text): expense (money spent) or extra (money earned)

**Example output**

```json
{
  "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**

- Listing (`listing`, text, required): The listing to book.
- Arrival date (`arrival_date`, date, required): The day the guest arrives.
- Departure date (`departure_date`, date, required): The day the guest leaves.
- Channel (`channel`, text): Where the booking came from. One of: `2000` (Direct), `2020` (Partner), `2002` (Vrbo). Default: `2000`.
- Guest first name (`guest_first_name`, text): The guest's first name.
- Guest last name (`guest_last_name`, text): The guest's last name.
- Guest email (`guest_email`, text): The guest's email address.
- Guest phone (`guest_phone`, text): The guest's phone number with its country code, such as +1 512 555 0134.
- Guests (`guests`, number): How many guests in all, such as 2. At least 1.
- Adults (`adults`, number): How many of them are adults. At least 0.
- Children (`children`, number): How many of them are children. At least 0.
- Infants (`infants`, number): How many of them are infants. At least 0.
- Pets (`pets`, number): How many pets are coming. At least 0.
- Total price (`total_price`, number): The stay's total price, such as 450. At least 0.
- Currency (`currency`, text): The price's three-letter currency code, such as USD. Leave blank for the listing's.
- Guest note (`guest_note`, text): A note from the guest.
- Host note (`host_note`, text): Your own note on the reservation.
- Door code (`door_code`, text): The door code for this stay.
- Allow overbooking (`allow_overbooking`, true/false): Save it even when the dates are already booked or blocked. Off by default, so Hostaway refuses a clash. Default: `false`.

**Outputs**

- `adults` (number): How many adults
- `arrival_date` (text): The arrival date (YYYY-MM-DD)
- `assignee_user_id` (text): The Hostaway user it is assigned to
- `booked_at` (text): When it was booked (YYYY-MM-DD HH:MM:SS)
- `cancelled_at` (text): When it was cancelled; empty if it wasn't
- `cancelled_by` (text): Who cancelled it: host or guest
- `channel` (text): The channel it was booked on, such as Airbnb or Direct
- `channel_id` (text): The channel's ID, such as 2018 for Airbnb
- `channel_reservation_id` (text): Its ID on the channel it came from
- `check_in_hour` (number): The check-in hour (0 to 23), if set
- `check_out_hour` (number): The check-out hour (0 to 23), if set
- `children` (number): How many children
- `confirmation_code` (text): The channel's confirmation code, such as Airbnb's
- `created_at` (text): When it was added to Hostaway (YYYY-MM-DD HH:MM:SS, UTC)
- `currency` (text): The price's currency, such as USD
- `departure_date` (text): The departure date (YYYY-MM-DD)
- `door_code` (text): The door code for the stay
- `guest_address` (text): The guest's street address
- `guest_city` (text): The guest's city
- `guest_country` (text): The guest's country code
- `guest_email` (text): The guest's email
- `guest_first_name` (text): The guest's first name
- `guest_last_name` (text): The guest's last name
- `guest_name` (text): The guest's full name
- `guest_note` (text): The guest's note
- `guest_phone` (text): The guest's phone number
- `guest_zip_code` (text): The guest's ZIP or postcode
- `guests` (number): How many guests in all
- `host_note` (text): The host's note
- `id` (text): The reservation's Hostaway ID
- `infants` (number): How many infants
- `is_paid` (true/false): Whether it is marked paid
- `listing_id` (text): The listing's ID
- `listing_name` (text): The listing's name
- `nights` (number): How many nights
- `pets` (number): How many pets
- `source` (text): Where it came from, as the creator set it
- `status` (text): Its status as Hostaway stores it, such as new or cancelled
- `status_label` (text): Its status in words, such as New or Cancelled
- `total_price` (number): The total price
- `updated_at` (text): When it last changed (YYYY-MM-DD HH:MM:SS, UTC)

**Example output**

```json
{
  "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**

- Title (`title`, text, required): What needs doing, such as Clean after check-out.
- Description (`description`, text): More about what to do.
- Listing (`listing`, text): The listing it is for.
- Reservation (`reservation`, text): The reservation's ID, from another Hostaway step or the trigger.
- Assignee (`assignee`, text): The Hostaway user who does it.
- Starts (`starts_at`, date and time): When it can start.
- Due (`due_at`, date and time): When it should be done by.
- Categories (`categories`, list): 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).
- Status (`status`, text): Where it stands. Leave blank for Pending. One of: `pending`, `confirmed`, `inProgress` (In progress), `completed`, `cancelled`.

**Outputs**

- `assignee_name` (text): Their name
- `assignee_user_id` (text): The Hostaway user it is given to
- `categories` (list): Its categories, such as Cleaning
- `completed_at` (text): When it was completed
- `description` (text): More about it
- `due_at` (text): When it should be done by (YYYY-MM-DD HH:MM:SS, UTC)
- `id` (text): The task's ID
- `listing_id` (text): The listing it is for
- `listing_name` (text): The listing's name
- `reservation_id` (text): The reservation it is for
- `resolution_note` (text): The note left when it was resolved
- `started_at` (text): When it was started
- `starts_at` (text): When it can start (YYYY-MM-DD HH:MM:SS, UTC)
- `status` (text): Its status as Hostaway stores it: pending, confirmed, inProgress, completed or cancelled
- `status_label` (text): Its status in words
- `title` (text): What needs doing

**Example output**

```json
{
  "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**

- Expense (`expense`, text, required): The expense or extra's ID, from another Hostaway step or the trigger.

**Outputs**

- `deleted` (true/false): Always true once it is gone
- `id` (text): The ID of what was deleted

**Example output**

```json
{
  "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**

- Reservation (`reservation`, text, required): The reservation's ID, from another Hostaway step or the trigger.

**Outputs**

- `deleted` (true/false): Always true once it is gone
- `id` (text): The ID of what was deleted

**Example output**

```json
{
  "deleted": true,
  "id": "13"
}
```

### Delete task

Delete a task for good.

**Inputs**

- Task (`task`, text, required): The task's ID, from another Hostaway step or the trigger.

**Outputs**

- `deleted` (true/false): Always true once it is gone
- `id` (text): The ID of what was deleted

**Example output**

```json
{
  "deleted": true,
  "id": "1"
}
```

### Find conversations

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

**Inputs**

- Reservation (`reservation`, text): The reservation's ID, from another Hostaway step or the trigger.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `conversations` (list): The conversations found
- `count` (number): How many are listed
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Email (`email`, text): The guest's email address.
- Name (`name`, text): Words in the guest's name, such as Peterson.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many guests were found
- `guests` (list): The guests found

**Example output**

```json
{
  "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**

- Name (`name`, text): Words in the listing's name.
- City (`city`, text): The listing's city.
- Country (`country`, text): The listing's country.
- Free from (`available_from`, date): Only listings free from this day. Give the last day too.
- Free until (`available_to`, date): Only listings free until this day.
- Guests (`guests`, number): Only listings that sleep at least this many. At least 1.
- Include archived (`include_archived`, true/false): Also list archived listings. Default: `false`.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many are listed
- `listings` (list): The listings found
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Listing (`listing`, text): Only reservations for this listing.
- Channel (`channel`, text): 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 name (`guest_name`, text): Words in the guest's name, such as Peterson.
- Guest email (`guest_email`, text): The guest's email address.
- Arriving from (`arrival_from`, date): Only arrivals on or after this day.
- Arriving until (`arrival_to`, date): Only arrivals on or before this day.
- Leaving from (`departure_from`, date): Only departures on or after this day.
- Leaving until (`departure_to`, date): Only departures on or before this day.
- Unread messages only (`unread_messages_only`, true/false): Only reservations with guest messages nobody has read. Default: `false`.
- Order (`order`, text): 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 many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many are listed
- `reservations` (list): The reservations found
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Listings (`listings`, list): Only reviews of these listings.
- Kind (`review_type`, text): Guests' reviews of you, or yours of them. One of: `guest-to-host` (Guests' reviews of you), `host-to-guest` (Your reviews of guests).
- Statuses (`statuses`, list): Only reviews in these statuses. One or more of: `published`, `submitted`, `scheduled`, `pending`, `awaiting`, `expired`.
- Channels (`channels`, list): 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 name (`guest_name`, text): Words in the guest's name.
- Lowest rating (`lowest_rating`, number): Only reviews rated at least this, from 0 to 10. From 0 to 10.
- Highest rating (`highest_rating`, number): Only reviews rated at most this, from 0 to 10. From 0 to 10.
- Written from (`submitted_from`, date): Only reviews written on or after this day.
- Written until (`submitted_to`, date): Only reviews written on or before this day.
- Your reply (`host_reply`, text): Only reviews you have answered, or only those you haven't. One of: `yes` (Answered), `no` (Not answered yet).
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many are listed
- `reviews` (list): The reviews found
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Reservation (`reservation`, text): The reservation's ID, from another Hostaway step or the trigger.
- Status (`status`, text): Only tasks in this status. One of: `pending`, `confirmed`, `inProgress` (In progress), `completed`, `cancelled`.
- Words (`text`, text): Words in the task, such as cleaning.
- Starting from (`starts_from`, date): Only tasks starting on or after this day.
- Starting until (`starts_to`, date): Only tasks starting on or before this day.
- Due from (`due_from`, date): Only tasks due on or after this day.
- Due until (`due_to`, date): Only tasks due on or before this day.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many are listed
- `tasks` (list): The tasks found
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Listing (`listing`, text, required): The listing.
- From (`start_date`, date, required): The first day.
- To (`end_date`, date, required): The last day.

**Outputs**

- `available_days` (number): How many of them can be booked
- `count` (number): How many days
- `days` (list): Each day, in order
- `listing_id` (text): The listing's ID

**Example output**

```json
{
  "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**

- Listing (`listing`, text, required): The listing.

**Outputs**

- `address` (text): Its full address
- `airbnb_url` (text): Its page on Airbnb
- `archived` (true/false): Whether it is archived
- `average_review_rating` (number): Its average review rating, 0 to 10
- `bathrooms` (number): How many bathrooms
- `bedrooms` (number): How many bedrooms
- `beds` (number): How many beds
- `check_in_from_hour` (number): Check-in opens at this hour (0 to 23)
- `check_in_until_hour` (number): Check-in closes at this hour (0 to 23)
- `check_out_hour` (number): Check-out is by this hour (0 to 23)
- `city` (text): Its city
- `cleaning_fee` (number): Its cleaning fee
- `country` (text): Its country
- `country_code` (text): Its two-letter country code
- `currency` (text): Its currency, such as USD
- `description` (text): Its description
- `guests_included` (number): How many guests the price includes
- `id` (text): The listing's ID
- `internal_name` (text): Its internal name
- `max_guests` (number): How many guests it sleeps
- `max_nights` (number): The most nights a stay can be
- `min_nights` (number): The fewest nights a stay can be
- `name` (text): Its public name
- `price` (number): Its base nightly price
- `room_type` (text): entire_home, private_room or shared_room
- `state` (text): Its state or region
- `street` (text): Its street
- `time_zone` (text): Its time zone, such as Europe/Berlin
- `vrbo_url` (text): Its page on Vrbo
- `zip_code` (text): Its ZIP or postcode

**Example output**

```json
{
  "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**

- Reservation (`reservation`, text, required): The reservation's ID, from another Hostaway step or the trigger.

**Outputs**

- `adults` (number): How many adults
- `arrival_date` (text): The arrival date (YYYY-MM-DD)
- `assignee_user_id` (text): The Hostaway user it is assigned to
- `booked_at` (text): When it was booked (YYYY-MM-DD HH:MM:SS)
- `cancelled_at` (text): When it was cancelled; empty if it wasn't
- `cancelled_by` (text): Who cancelled it: host or guest
- `channel` (text): The channel it was booked on, such as Airbnb or Direct
- `channel_id` (text): The channel's ID, such as 2018 for Airbnb
- `channel_reservation_id` (text): Its ID on the channel it came from
- `check_in_hour` (number): The check-in hour (0 to 23), if set
- `check_out_hour` (number): The check-out hour (0 to 23), if set
- `children` (number): How many children
- `confirmation_code` (text): The channel's confirmation code, such as Airbnb's
- `created_at` (text): When it was added to Hostaway (YYYY-MM-DD HH:MM:SS, UTC)
- `currency` (text): The price's currency, such as USD
- `departure_date` (text): The departure date (YYYY-MM-DD)
- `door_code` (text): The door code for the stay
- `guest_address` (text): The guest's street address
- `guest_city` (text): The guest's city
- `guest_country` (text): The guest's country code
- `guest_email` (text): The guest's email
- `guest_first_name` (text): The guest's first name
- `guest_last_name` (text): The guest's last name
- `guest_name` (text): The guest's full name
- `guest_note` (text): The guest's note
- `guest_phone` (text): The guest's phone number
- `guest_zip_code` (text): The guest's ZIP or postcode
- `guests` (number): How many guests in all
- `host_note` (text): The host's note
- `id` (text): The reservation's Hostaway ID
- `infants` (number): How many infants
- `is_paid` (true/false): Whether it is marked paid
- `listing_id` (text): The listing's ID
- `listing_name` (text): The listing's name
- `nights` (number): How many nights
- `pets` (number): How many pets
- `source` (text): Where it came from, as the creator set it
- `status` (text): Its status as Hostaway stores it, such as new or cancelled
- `status_label` (text): Its status in words, such as New or Cancelled
- `total_price` (number): The total price
- `updated_at` (text): When it last changed (YYYY-MM-DD HH:MM:SS, UTC)

**Example output**

```json
{
  "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**

- Reservation (`reservation`, text, required): The reservation's ID, from another Hostaway step or the trigger.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `changes` (list): Each change, newest first
- `count` (number): How many are listed
- `reservation_id` (text): The reservation's ID
- `total` (number): How many changes there are in all

**Example output**

```json
{
  "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**

- Task (`task`, text, required): The task's ID, from another Hostaway step or the trigger.

**Outputs**

- `assignee_name` (text): Their name
- `assignee_user_id` (text): The Hostaway user it is given to
- `categories` (list): Its categories, such as Cleaning
- `completed_at` (text): When it was completed
- `description` (text): More about it
- `due_at` (text): When it should be done by (YYYY-MM-DD HH:MM:SS, UTC)
- `id` (text): The task's ID
- `listing_id` (text): The listing it is for
- `listing_name` (text): The listing's name
- `reservation_id` (text): The reservation it is for
- `resolution_note` (text): The note left when it was resolved
- `started_at` (text): When it was started
- `starts_at` (text): When it can start (YYYY-MM-DD HH:MM:SS, UTC)
- `status` (text): Its status as Hostaway stores it: pending, confirmed, inProgress, completed or cancelled
- `status_label` (text): Its status in words
- `title` (text): What needs doing

**Example output**

```json
{
  "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 many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many are listed
- `expenses` (list): The expenses and extras, newest first

**Example output**

```json
{
  "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**

- Conversation (`conversation`, text, required): The conversation's ID, from another Hostaway step or the trigger.
- Include scheduled (`include_scheduled`, true/false): Also list messages waiting to go, failed or paused. Off lists only sent ones. Default: `false`.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `conversation_id` (text): The conversation's ID
- `count` (number): How many are listed
- `messages` (list): The messages
- `total` (number): How many messages there are in all

**Example output**

```json
{
  "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**

- Review (`review`, text, required): The review's ID, from another Hostaway step or the trigger.
- Reply (`response`, text, required): Your public reply to the guest.

**Outputs**

- `arrival_date` (text): The stay's arrival date
- `channel` (text): The channel it is on, such as Airbnb
- `channel_id` (text): The channel's ID
- `departure_date` (text): The stay's departure date
- `guest_name` (text): The guest's name
- `host_response` (text): Your public reply; empty if none
- `id` (text): The review's ID
- `listing_id` (text): The listing's ID
- `listing_name` (text): The listing's name
- `private_feedback` (text): The private feedback
- `public_review` (text): What it says publicly
- `rating` (number): Its rating, 0 to 10
- `reservation_id` (text): The reservation's ID
- `status` (text): published, submitted, scheduled, pending, awaiting or expired
- `type` (text): guest-to-host (a guest's review) or host-to-guest (yours)

**Example output**

```json
{
  "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**

- Conversation (`conversation`, text, required): The conversation's ID, from another Hostaway step or the trigger.
- Message (`message`, text, required): What to send the guest.
- Send by (`send_by`, text): 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_urls` (list): Links to its attachments
- `body` (text): What the message says
- `conversation_id` (text): The conversation's ID
- `created_at` (text): When Hostaway recorded it (YYYY-MM-DD HH:MM:SS)
- `from_guest` (true/false): Whether the guest sent it
- `id` (text): The message's ID
- `listing_id` (text): The listing's ID
- `reservation_id` (text): The reservation's ID
- `seen` (true/false): Whether it has been read
- `sent_at` (text): When it was sent (YYYY-MM-DD HH:MM:SS)
- `sent_by` (text): How it was sent: email, channel, sms or whatsapp
- `status` (text): sent, awaiting, failed, paused or cancelled

**Example output**

```json
{
  "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**

- Listing (`listing`, text, required): The listing.
- From (`start_date`, date, required): The first day to change.
- To (`end_date`, date, required): The last day to change.
- Availability (`availability`, text): Open the days for booking, or block them. Leave blank to keep it. One of: `available`, `blocked`.
- Nightly price (`price`, number): The new price for each night. At least 0.
- Minimum stay (`minimum_stay`, number): The fewest nights a stay can be. At least 1.
- Maximum stay (`maximum_stay`, number): The most nights a stay can be. At least 1.
- Units to sell (`units_to_sell`, number): For a listing with several identical units: how many to offer. 0 blocks them all. At least 0.
- Note (`note`, text): A note on the days.

**Outputs**

- `count` (number): How many days changed
- `days` (list): The days changed, as they are now
- `listing_id` (text): The listing's ID

**Example output**

```json
{
  "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**

- Reservation (`reservation`, text, required): The reservation's ID, from another Hostaway step or the trigger.
- Arrival date (`arrival_date`, date): A new arrival day.
- Departure date (`departure_date`, date): A new departure day.
- Guest first name (`guest_first_name`, text): The guest's first name.
- Guest last name (`guest_last_name`, text): The guest's last name.
- Guest email (`guest_email`, text): The guest's email address.
- Guest phone (`guest_phone`, text): The guest's phone number with its country code, such as +1 512 555 0134.
- Guests (`guests`, number): How many guests in all, such as 2. At least 1.
- Adults (`adults`, number): How many of them are adults. At least 0.
- Children (`children`, number): How many of them are children. At least 0.
- Infants (`infants`, number): How many of them are infants. At least 0.
- Pets (`pets`, number): How many pets are coming. At least 0.
- Total price (`total_price`, number): The stay's total price, such as 450. At least 0.
- Guest note (`guest_note`, text): A note from the guest.
- Host note (`host_note`, text): Your own note on the reservation.
- Door code (`door_code`, text): The door code for this stay.
- Allow overbooking (`allow_overbooking`, true/false): Save it even when the dates are already booked or blocked. Off by default, so Hostaway refuses a clash. Default: `false`.

**Outputs**

- `adults` (number): How many adults
- `arrival_date` (text): The arrival date (YYYY-MM-DD)
- `assignee_user_id` (text): The Hostaway user it is assigned to
- `booked_at` (text): When it was booked (YYYY-MM-DD HH:MM:SS)
- `cancelled_at` (text): When it was cancelled; empty if it wasn't
- `cancelled_by` (text): Who cancelled it: host or guest
- `channel` (text): The channel it was booked on, such as Airbnb or Direct
- `channel_id` (text): The channel's ID, such as 2018 for Airbnb
- `channel_reservation_id` (text): Its ID on the channel it came from
- `check_in_hour` (number): The check-in hour (0 to 23), if set
- `check_out_hour` (number): The check-out hour (0 to 23), if set
- `children` (number): How many children
- `confirmation_code` (text): The channel's confirmation code, such as Airbnb's
- `created_at` (text): When it was added to Hostaway (YYYY-MM-DD HH:MM:SS, UTC)
- `currency` (text): The price's currency, such as USD
- `departure_date` (text): The departure date (YYYY-MM-DD)
- `door_code` (text): The door code for the stay
- `guest_address` (text): The guest's street address
- `guest_city` (text): The guest's city
- `guest_country` (text): The guest's country code
- `guest_email` (text): The guest's email
- `guest_first_name` (text): The guest's first name
- `guest_last_name` (text): The guest's last name
- `guest_name` (text): The guest's full name
- `guest_note` (text): The guest's note
- `guest_phone` (text): The guest's phone number
- `guest_zip_code` (text): The guest's ZIP or postcode
- `guests` (number): How many guests in all
- `host_note` (text): The host's note
- `id` (text): The reservation's Hostaway ID
- `infants` (number): How many infants
- `is_paid` (true/false): Whether it is marked paid
- `listing_id` (text): The listing's ID
- `listing_name` (text): The listing's name
- `nights` (number): How many nights
- `pets` (number): How many pets
- `source` (text): Where it came from, as the creator set it
- `status` (text): Its status as Hostaway stores it, such as new or cancelled
- `status_label` (text): Its status in words, such as New or Cancelled
- `total_price` (number): The total price
- `updated_at` (text): When it last changed (YYYY-MM-DD HH:MM:SS, UTC)

**Example output**

```json
{
  "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**

- Task (`task`, text, required): The task's ID, from another Hostaway step or the trigger.
- Title (`title`, text): A new title. Leave blank to keep it.
- Description (`description`, text): More about what to do.
- Listing (`listing`, text): The listing it is for.
- Reservation (`reservation`, text): The reservation's ID, from another Hostaway step or the trigger.
- Assignee (`assignee`, text): The Hostaway user who does it.
- Starts (`starts_at`, date and time): When it can start.
- Due (`due_at`, date and time): When it should be done by.
- Categories (`categories`, list): 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).
- Status (`status`, text): Where it stands now, such as Completed. One of: `pending`, `confirmed`, `inProgress` (In progress), `completed`, `cancelled`.

**Outputs**

- `assignee_name` (text): Their name
- `assignee_user_id` (text): The Hostaway user it is given to
- `categories` (list): Its categories, such as Cleaning
- `completed_at` (text): When it was completed
- `description` (text): More about it
- `due_at` (text): When it should be done by (YYYY-MM-DD HH:MM:SS, UTC)
- `id` (text): The task's ID
- `listing_id` (text): The listing it is for
- `listing_name` (text): The listing's name
- `reservation_id` (text): The reservation it is for
- `resolution_note` (text): The note left when it was resolved
- `started_at` (text): When it was started
- `starts_at` (text): When it can start (YYYY-MM-DD HH:MM:SS, UTC)
- `status` (text): Its status as Hostaway stores it: pending, confirmed, inProgress, completed or cancelled
- `status_label` (text): Its status in words
- `title` (text): What needs doing

**Example output**

```json
{
  "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"
}
```
