Guesty

App · 25 actions

Run your short-term rentals on Guesty from your workflows: find, book, cancel and change reservations, message guests, block dates and set prices, and keep guests and tasks up to date. Start a workflow on a new, changed or cancelled reservation, a guest message or a review.

Actions

ActionWhat it does
Add note to conversationAdd a note for the team to a guest conversation.
Change reservation datesMove a stay's check-in or check-out day, or set the guest's arrival or departure time.
Change reservation statusMove a reservation to another status, such as confirming or cancelling it.
Create guestAdd a guest to Guesty, ready to book for.
Create reservationBook a listing for a guest, priced by the listing's own rates.
Create taskAdd a task, such as a cleaning or a repair, for a listing or a reservation, given to a team member at a time or within a window.
Delete taskDelete a task for good.
Find conversationsFind guest conversations in the inbox by reservation, guest or listing, or only unread ones, the newest first.
Find guestsFind guests by their email or a tag.
Find listingsFind listings by words in their title or address, city or tag, or those free to book between two dates.
Find reservationsFind reservations by status, listing, check-in or check-out dates, when they were booked, confirmation code or source.
Find tasksFind tasks by status, such as everything pending, and by listing.
Get guestGet a guest's contact details, tags and notes.
Get listingGet a listing's title, address, check-in and check-out times, base price and stay limits.
Get listing calendarGet a listing's availability, nightly price and minimum stay for each day between two dates, up to 366 days.
Get ownerGet a property owner's contact details and the listings they own.
Get reservationGet a reservation's dates, guests, status, door code and notes, and its guest conversation for sending messages.
Get taskGet a task's status, times, assignee and checklist.
List conversation messagesList the latest messages and notes in a guest conversation, the newest first.
List ownersList the property owners in Guesty, with the listings each owns.
Send message to guestSend the guest a message in their conversation, through their booking channel, email, text or WhatsApp.
Update guestChange a guest's details.
Update listing calendarBlock or open a listing's days, or set their nightly price or minimum stay.
Update reservation notesSet a reservation's door code, special requests or notes.
Update taskChange a task, such as marking it completed or giving it to someone else.

Add note to conversation

Add a note for the team to a guest conversation. The guest doesn't see it.

Inputs

ConversationconversationtextRequired
The conversation's ID, from 'Find conversations', a reservation's conversation ID, or the new guest message trigger.
NotenotetextRequired
What the note says.

Outputs

bodytext
What it says
channeltext
How it was sent, such as email, sms, airbnb2 or note
conversation_idtext
Its conversation's ID
created_attext
When it was sent (ISO 8601)
from_guesttrue/false
Whether the guest sent it
from_nametext
The name of the team member who sent it; empty if none
idtext
The message's ID
sent_bytext
Who sent it: guest, host or log
Example output
{
  "body": "This is new note(COM postman)",
  "channel": "note",
  "conversation_id": "615997c2e74f61003015ab02",
  "created_at": "2021-10-11T14:01:17.207Z",
  "from_guest": false,
  "from_name": "COM - postman",
  "id": "616443adc9cf7a002d92933a",
  "sent_by": "host"
}

Change reservation dates

Move a stay's check-in or check-out day, or set the guest's arrival or departure time. Guesty prices the new dates again.

Inputs

ReservationreservationtextRequired
The reservation's ID, from another Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.
Check-incheck_indate
The new check-in day.
Check-outcheck_outdate
The new check-out day.
Arrival timearrival_timetime
When the guest arrives, if not the usual check-in time.
Departure timedeparture_timetime
When the guest leaves, if not the usual check-out time.
Change even if unavailablebook_anywaytrue/false
Change the dates even if they're taken or break the listing's rules, such as its minimum stay.

Outputs

adultsnumber
How many adults; empty if not given
booking_datetext
When it was booked (ISO 8601)
canceled_attext
When it was cancelled (ISO 8601); empty if not shown
channeltext
The channel it was booked through
check_intext
The check-in date in the listing's time zone (YYYY-MM-DD)
check_in_attext
When the guest is due to arrive (ISO 8601, UTC)
check_outtext
The check-out date in the listing's time zone (YYYY-MM-DD)
check_out_attext
When the guest is due to leave (ISO 8601, UTC)
childrennumber
How many children; empty if not given
cleaning_notetext
The note for cleaning
confirmation_codetext
Its confirmation code
confirmed_attext
When it was confirmed (ISO 8601); empty if not shown
conversation_idtext
The ID of its guest conversation, for sending messages; empty if not shown
created_attext
When it entered Guesty (ISO 8601)
guest_idtext
The ID of the guest who booked
guest_notetext
The note about the guest
guests_countnumber
How many guests are staying
idtext
The reservation's ID
infantsnumber
How many infants; empty if not given
key_codetext
The door or key code kept on it
listing_idtext
The ID of the listing it's for
nightsnumber
How many nights the stay is
other_notetext
Other notes
petsnumber
How many pets; empty if not given
sourcetext
Where it came from, such as airbnb, booking.com or manual
special_requeststext
The guest's special requests
statustext
Its status as Guesty stores it, such as confirmed, inquiry or canceled
status_labeltext
Its status as Guesty shows it
Example output
{
  "adults": 2,
  "booking_date": "2026-01-01T00:00:00.000Z",
  "canceled_at": "",
  "channel": "manual",
  "check_in": "2026-01-15",
  "check_in_at": "2026-01-15T14:00:00.000Z",
  "check_out": "2026-01-20",
  "check_out_at": "2026-01-20T11:00:00.000Z",
  "children": 0,
  "cleaning_note": "Cleaning notes",
  "confirmation_code": "ABC123",
  "confirmed_at": "2026-01-01T00:05:00.000Z",
  "conversation_id": "615997c2e74f61003015ab02",
  "created_at": "2026-01-01T00:00:00.000Z",
  "guest_id": "65aff36cbf774b59c718a0c8",
  "guest_note": "Guest notes",
  "guests_count": 2,
  "id": "65aff36cbf774b59c718a0c7",
  "infants": 0,
  "key_code": "123456",
  "listing_id": "6213b03e7f0ba50032296f4a",
  "nights": 5,
  "other_note": "Other notes",
  "pets": 0,
  "source": "manual",
  "special_requests": "Special request",
  "status": "confirmed",
  "status_label": "Confirmed"
}

Change reservation status

Move a reservation to another status, such as confirming or cancelling it. A booking channel's reservation (Airbnb, Booking.com) can only be cancelled.

Inputs

ReservationreservationtextRequired
The reservation's ID, from another Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.
StatusstatustextRequired
The status to move it to.One of: inquiry, reserved, awaiting_payment (Awaiting payment), confirmed, canceled (Cancelled), declined, expired, closed.
Cancelled bycanceled_bytext
Who cancelled it, when cancelling. Defaults to Team member.One of: GUEST, HOST, OWNER, TEAM_MEMBER (Team member).
Cancellation reasoncancellation_reasontext
Why it was cancelled, when cancelling.
Cancellation notecancellation_notetext
A note about the cancellation.

Outputs

adultsnumber
How many adults; empty if not given
booking_datetext
When it was booked (ISO 8601)
canceled_attext
When it was cancelled (ISO 8601); empty if not shown
channeltext
The channel it was booked through
check_intext
The check-in date in the listing's time zone (YYYY-MM-DD)
check_in_attext
When the guest is due to arrive (ISO 8601, UTC)
check_outtext
The check-out date in the listing's time zone (YYYY-MM-DD)
check_out_attext
When the guest is due to leave (ISO 8601, UTC)
childrennumber
How many children; empty if not given
cleaning_notetext
The note for cleaning
confirmation_codetext
Its confirmation code
confirmed_attext
When it was confirmed (ISO 8601); empty if not shown
conversation_idtext
The ID of its guest conversation, for sending messages; empty if not shown
created_attext
When it entered Guesty (ISO 8601)
guest_idtext
The ID of the guest who booked
guest_notetext
The note about the guest
guests_countnumber
How many guests are staying
idtext
The reservation's ID
infantsnumber
How many infants; empty if not given
key_codetext
The door or key code kept on it
listing_idtext
The ID of the listing it's for
nightsnumber
How many nights the stay is
other_notetext
Other notes
petsnumber
How many pets; empty if not given
sourcetext
Where it came from, such as airbnb, booking.com or manual
special_requeststext
The guest's special requests
statustext
Its status as Guesty stores it, such as confirmed, inquiry or canceled
status_labeltext
Its status as Guesty shows it
Example output
{
  "adults": 2,
  "booking_date": "2026-01-01T00:00:00.000Z",
  "canceled_at": "",
  "channel": "manual",
  "check_in": "2026-01-15",
  "check_in_at": "2026-01-15T14:00:00.000Z",
  "check_out": "2026-01-20",
  "check_out_at": "2026-01-20T11:00:00.000Z",
  "children": 0,
  "cleaning_note": "Cleaning notes",
  "confirmation_code": "ABC123",
  "confirmed_at": "2026-01-01T00:05:00.000Z",
  "conversation_id": "615997c2e74f61003015ab02",
  "created_at": "2026-01-01T00:00:00.000Z",
  "guest_id": "65aff36cbf774b59c718a0c8",
  "guest_note": "Guest notes",
  "guests_count": 2,
  "id": "65aff36cbf774b59c718a0c7",
  "infants": 0,
  "key_code": "123456",
  "listing_id": "6213b03e7f0ba50032296f4a",
  "nights": 5,
  "other_note": "Other notes",
  "pets": 0,
  "source": "manual",
  "special_requests": "Special request",
  "status": "confirmed",
  "status_label": "Confirmed"
}

Create guest

Add a guest to Guesty, ready to book for.

Inputs

First namefirst_nametextRequired
Their first name.
Last namelast_nametextRequired
Their last name.
Emailemailtext
Their main email.
Phonephonetext
Their main phone number with its country code, such as +14155550134.
Hometownhometowntext
Where they live, such as New York.
Notesnotestext
What the team should know about them for every stay.
Tagstagslist
Tags to give them.One or more of: vip, friendsAndFamily (Friends and family), loyaltyProgram (Loyalty program), staff, management, blocklisted.
Preferred languagepreferred_languagetext
Their language as a two-letter code, such as en or es.

Outputs

created_attext
When they were added to Guesty (ISO 8601)
emailtext
Their main email
first_nametext
Their first name
full_nametext
Their full name
good_to_know_notestext
Good-to-know notes about them
hometowntext
Where they live
idtext
The guest's ID
last_nametext
Their last name
notestext
Notes for the team about them
other_emailslist
Their other emails
other_phoneslist
Their other phone numbers
phonetext
Their main phone number
preferred_languagetext
Their language, as a two-letter code
returning_guesttrue/false
Whether they've stayed before
tagslist
Their tags, such as vip
Example output
{
  "created_at": "2022-08-12T16:00:00.000+03:00",
  "email": "email@email.com",
  "first_name": "Rick",
  "full_name": "Rick Sanchez",
  "good_to_know_notes": "This guest is allergic to peanuts",
  "hometown": "New York",
  "id": "5e17287629e111001f7d3f4d",
  "last_name": "Sanchez",
  "notes": "This guest is rich",
  "other_emails": [],
  "other_phones": [],
  "phone": "972234567454",
  "preferred_language": "en",
  "returning_guest": false,
  "tags": [
    "vip"
  ]
}

Create reservation

Book a listing for a guest, priced by the listing's own rates. Name a guest already in Guesty, or give a new guest's name and email.

Inputs

ListinglistingtextRequired
The listing to book.
Check-incheck_indateRequired
The day the guest arrives.
Check-outcheck_outdateRequired
The day the guest leaves.
Guestsguests_countnumberRequired
How many guests are staying.At least 1.
StatusstatustextRequired
Confirmed books the dates; Inquiry holds nothing.One of: inquiry, reserved, awaiting_payment (Awaiting payment), confirmed.
Guestguesttext
The guest's ID, from another Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.
New guest's first nameguest_first_nametext
For a guest not yet in Guesty.
New guest's last nameguest_last_nametext
For a guest not yet in Guesty.
New guest's emailguest_emailtext
For a guest not yet in Guesty.
New guest's phoneguest_phonetext
With its country code, such as +14155550134.
Sourcesourcetext
Where the booking came from, such as website. Defaults to manual.
Accommodation fareaccommodation_farenumber
A fixed price for the stay, in place of the listing's nightly rates.At least 0.
Cleaning feecleaning_feenumber
A fixed cleaning fee for the stay.At least 0.
Book even if unavailablebook_anywaytrue/false
Book even if the dates are taken or break the listing's rules, such as its minimum stay: for a booking agreed elsewhere.

Outputs

adultsnumber
How many adults; empty if not given
booking_datetext
When it was booked (ISO 8601)
canceled_attext
When it was cancelled (ISO 8601); empty if not shown
channeltext
The channel it was booked through
check_intext
The check-in date in the listing's time zone (YYYY-MM-DD)
check_in_attext
When the guest is due to arrive (ISO 8601, UTC)
check_outtext
The check-out date in the listing's time zone (YYYY-MM-DD)
check_out_attext
When the guest is due to leave (ISO 8601, UTC)
childrennumber
How many children; empty if not given
cleaning_notetext
The note for cleaning
confirmation_codetext
Its confirmation code
confirmed_attext
When it was confirmed (ISO 8601); empty if not shown
conversation_idtext
The ID of its guest conversation, for sending messages; empty if not shown
created_attext
When it entered Guesty (ISO 8601)
guest_idtext
The ID of the guest who booked
guest_notetext
The note about the guest
guests_countnumber
How many guests are staying
idtext
The reservation's ID
infantsnumber
How many infants; empty if not given
key_codetext
The door or key code kept on it
listing_idtext
The ID of the listing it's for
nightsnumber
How many nights the stay is
other_notetext
Other notes
petsnumber
How many pets; empty if not given
sourcetext
Where it came from, such as airbnb, booking.com or manual
special_requeststext
The guest's special requests
statustext
Its status as Guesty stores it, such as confirmed, inquiry or canceled
status_labeltext
Its status as Guesty shows it
Example output
{
  "adults": 2,
  "booking_date": "2026-01-01T00:00:00.000Z",
  "canceled_at": "",
  "channel": "manual",
  "check_in": "2026-01-15",
  "check_in_at": "2026-01-15T14:00:00.000Z",
  "check_out": "2026-01-20",
  "check_out_at": "2026-01-20T11:00:00.000Z",
  "children": 0,
  "cleaning_note": "Cleaning notes",
  "confirmation_code": "ABC123",
  "confirmed_at": "2026-01-01T00:05:00.000Z",
  "conversation_id": "615997c2e74f61003015ab02",
  "created_at": "2026-01-01T00:00:00.000Z",
  "guest_id": "65aff36cbf774b59c718a0c8",
  "guest_note": "Guest notes",
  "guests_count": 2,
  "id": "65aff36cbf774b59c718a0c7",
  "infants": 0,
  "key_code": "123456",
  "listing_id": "6213b03e7f0ba50032296f4a",
  "nights": 5,
  "other_note": "Other notes",
  "pets": 0,
  "source": "manual",
  "special_requests": "Special request",
  "status": "confirmed",
  "status_label": "Confirmed"
}

Create task

Add a task, such as a cleaning or a repair, for a listing or a reservation, given to a team member at a time or within a window.

Inputs

TitletitletextRequired
What the task is called.
Descriptiondescriptiontext
What it involves.
Typetask_typetext
What kind of task it is.One of: cleaning, maintenance, inspection, check-in, mid-stay, runner, sanitation, issue, inventory, administration.
Priorityprioritytext
How urgent it is. Leave blank for Medium on a new task.One of: low, medium, high.
Assigneeassigneetext
The team member who does it.
Listinglistingtext
The listing it's for.
Reservationreservationtext
The reservation's ID, from another Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.
Start timestart_timedate and time
When it must start. Leave blank to give a window instead.
Can start aftercan_start_afterdate and time
The start of its window.
Must finish beforemust_finish_beforedate and time
The end of its window.
Checklistchecklisttext
Items to tick off, one per line.
Planned hoursplanned_hoursnumber
How many hours it should take, such as 1.5.At least 0.

Outputs

assignee_idtext
The ID of the team member doing it
can_start_aftertext
The start of its window (ISO 8601)
checklistlist
Its checklist items
created_bytext
The ID of the team member who added it
descriptiontext
What it involves
idtext
The task's ID
listing_idtext
The ID of the listing it's for
listing_titletext
That listing's title; empty if not shown
must_finish_beforetext
The end of its window (ISO 8601)
prioritytext
Its priority: low, medium or high
reservation_idtext
The ID of the reservation it's for; empty if none
short_idtext
Its short ID, for quick reference
start_timetext
When it starts (ISO 8601); empty for a window
statustext
Its status: pending, confirmed, in progress, completed or canceled
supervisor_idtext
The ID of the team member supervising it
titletext
What it's called
typetext
Its type, such as cleaning or maintenance
Example output
{
  "assignee_id": "611d02b7c9c54b01736ae01d",
  "can_start_after": "",
  "checklist": [
    "Change linen",
    "Restock coffee"
  ],
  "created_by": "611d02b7c9c54b01736ae01d",
  "description": "Full clean after check-out.",
  "id": "66851bfe7ac4c20e71804f09",
  "listing_id": "5f92cbf10cf217478ba93561",
  "listing_title": "",
  "must_finish_before": "",
  "priority": "medium",
  "reservation_id": "",
  "short_id": "T-1042",
  "start_time": "2026-01-20T11:00:00.000Z",
  "status": "pending",
  "supervisor_id": "",
  "title": "Turnover clean",
  "type": "cleaning"
}

Delete task

Delete a task for good.

Inputs

TasktasktextRequired
The task's ID, from another Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.

Outputs

deletedtrue/false
Whether Guesty deleted it
idtext
The deleted task's ID
Example output
{
  "deleted": true,
  "id": "66851bfe7ac4c20e71804f09"
}

Find conversations

Find guest conversations in the inbox by reservation, guest or listing, or only unread ones, the newest first.

Inputs

Reservationreservationtext
The reservation's ID, from another Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.
Guestguesttext
The guest's ID, from another Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.
Listinglistingtext
Only conversations about this listing.
Unread onlyunread_onlytrue/false
Only conversations nobody has read.
How manylimitnumber
The most conversations to list. Defaults to 25.From 1 to 100. Default: 25.

Outputs

conversationslist
The conversations found
countnumber
How many are listed
Example output
{
  "conversations": [
    {
      "check_in_at": "2021-09-04T21:00:00.000Z",
      "check_out_at": "2021-09-05T20:00:00.000Z",
      "confirmation_code": "",
      "created_at": "2021-09-05T11:06:05.388Z",
      "guest_email": "asdasd@assadsa.com",
      "guest_id": "61347d70d450d300307792a3",
      "guest_name": "",
      "id": "6134a49cd450d300307794cb",
      "last_message": "",
      "listing_id": "5fba2d97d8e638002d76d842",
      "listing_title": "OPS-Listing",
      "modified_at": "",
      "read": false,
      "reservation_id": "61347d71d450d300307792a4",
      "reservation_status": "inquiry",
      "status": "OPEN"
    }
  ],
  "count": 1
}

Find guests

Find guests by their email or a tag. Leave both blank to list guests.

Inputs

Emailemailtext
The guest's email.
Tagtagtext
Only guests with this tag.One of: vip, friendsAndFamily (Friends and family), loyaltyProgram (Loyalty program), staff, management, blocklisted.
How manylimitnumber
The most guests to list. Defaults to 25.From 1 to 100. Default: 25.

Outputs

countnumber
How many are listed
guestslist
The guests found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "guests": [
    {
      "created_at": "2022-08-12T16:00:00.000+03:00",
      "email": "email@email.com",
      "first_name": "Rick",
      "full_name": "Rick Sanchez",
      "good_to_know_notes": "This guest is allergic to peanuts",
      "hometown": "New York",
      "id": "5e17287629e111001f7d3f4d",
      "last_name": "Sanchez",
      "notes": "This guest is rich",
      "other_emails": [],
      "other_phones": [],
      "phone": "972234567454",
      "preferred_language": "en",
      "returning_guest": false,
      "tags": [
        "vip"
      ]
    }
  ],
  "total": 1
}

Find listings

Find listings by words in their title or address, city or tag, or those free to book between two dates.

Inputs

Searchsearchtext
Words in the listing's title, internal note or address.
Citycitytext
Only listings in this city.
Tagtagtext
Only listings with this tag.
Which listingsstatetext
Active, inactive or all listings.One of: active (Active listings), inactive (Inactive listings), all (All listings). Default: active.
Free fromavailable_fromdate
Only listings free from this check-in day.
Free untilavailable_todate
Until this check-out day. Give it with 'Free from'.
Guestsguestsnumber
With 'Free from', only listings that sleep this many.At least 1.
How manylimitnumber
The most listings to list. Defaults to 25.From 1 to 100. Default: 25.

Outputs

countnumber
How many are listed
listingslist
The listings found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "listings": [
    {
      "accommodates": 4,
      "active": true,
      "address": "Kaplan St 2, Ramat Gan, Israel",
      "base_price": 150,
      "bedrooms": 2,
      "check_in_time": "15:00",
      "check_out_time": "11:00",
      "city": "Ramat Gan",
      "cleaning_fee": 50,
      "country": "Israel",
      "created_at": "2017-09-03T15:48:45.070Z",
      "currency": "USD",
      "id": "59ac245d27cb310f0017afe3",
      "listed": true,
      "max_nights": 30,
      "min_nights": 1,
      "nickname": "Kaplan 2",
      "picture": "https://res.cloudinary.com/guesty/image/upload/c_fit,w_756/v1659982852/listing.jpg",
      "property_type": "Apartment",
      "room_type": "Entire home/apt",
      "tags": [
        "Pool"
      ],
      "timezone": "Asia/Jerusalem",
      "title": "Cozy luxurious loft"
    }
  ],
  "total": 1
}

Find reservations

Find reservations by status, listing, check-in or check-out dates, when they were booked, confirmation code or source. Leave every field blank for the newest bookings.

Inputs

Statusstatuslist
Only reservations in these statuses.One or more of: inquiry, reserved, awaiting_payment (Awaiting payment), confirmed, checked_in (Checked in), checked_out (Checked out), completed, canceled (Cancelled), declined, expired, closed, alteration (Being changed).
Listinglistingtext
Only reservations for this listing.
Check-in fromcheck_in_fromdate
Only stays checking in on or after this day.
Check-in tocheck_in_todate
Only stays checking in on or before this day.
Check-out fromcheck_out_fromdate
Only stays checking out on or after this day.
Check-out tocheck_out_todate
Only stays checking out on or before this day.
Booked afterbooked_afterdate and time
Only reservations that entered Guesty at or after this time.
Confirmation codeconfirmation_codetext
The reservation's confirmation code, such as HMABC12345.
Sourcesourcetext
Where it came from, as Guesty names it, such as airbnb, booking.com or manual.
Ordersorttext
Which come first.One of: -createdAt (Newest booking first), createdAt (Oldest booking first), checkIn (Soonest check-in first), -checkIn (Latest check-in first), checkOut (Soonest check-out first). Default: -createdAt.
How manylimitnumber
The most reservations to list. Defaults to 25.From 1 to 100. Default: 25.

Outputs

countnumber
How many are listed
has_moretrue/false
Whether more reservations match than were listed
reservationslist
The reservations found
Example output
{
  "count": 1,
  "has_more": false,
  "reservations": [
    {
      "adults": 2,
      "booking_date": "2026-01-01T00:00:00.000Z",
      "canceled_at": "",
      "channel": "manual",
      "check_in": "2026-01-15",
      "check_in_at": "2026-01-15T14:00:00.000Z",
      "check_out": "2026-01-20",
      "check_out_at": "2026-01-20T11:00:00.000Z",
      "children": 0,
      "cleaning_note": "Cleaning notes",
      "confirmation_code": "ABC123",
      "confirmed_at": "2026-01-01T00:05:00.000Z",
      "conversation_id": "615997c2e74f61003015ab02",
      "created_at": "2026-01-01T00:00:00.000Z",
      "guest_id": "65aff36cbf774b59c718a0c8",
      "guest_note": "Guest notes",
      "guests_count": 2,
      "id": "65aff36cbf774b59c718a0c7",
      "infants": 0,
      "key_code": "123456",
      "listing_id": "6213b03e7f0ba50032296f4a",
      "nights": 5,
      "other_note": "Other notes",
      "pets": 0,
      "source": "manual",
      "special_requests": "Special request",
      "status": "confirmed",
      "status_label": "Confirmed"
    }
  ]
}

Find tasks

Find tasks by status, such as everything pending, and by listing.

Inputs

Statusstatuslist
Only tasks in these statuses.One or more of: pending, confirmed, in progress, completed, canceled (Cancelled).
Listinglistingtext
Only tasks for this listing, among the tasks read.
How manylimitnumber
The most tasks to list. Defaults to 25.From 25 to 100. Default: 25.

Outputs

countnumber
How many are listed
taskslist
The tasks found
Example output
{
  "count": 1,
  "tasks": [
    {
      "assignee_id": "611d02b7c9c54b01736ae01d",
      "can_start_after": "",
      "checklist": [
        "Change linen",
        "Restock coffee"
      ],
      "created_by": "611d02b7c9c54b01736ae01d",
      "description": "Full clean after check-out.",
      "id": "66851bfe7ac4c20e71804f09",
      "listing_id": "5f92cbf10cf217478ba93561",
      "listing_title": "",
      "must_finish_before": "",
      "priority": "medium",
      "reservation_id": "",
      "short_id": "T-1042",
      "start_time": "2026-01-20T11:00:00.000Z",
      "status": "pending",
      "supervisor_id": "",
      "title": "Turnover clean",
      "type": "cleaning"
    }
  ]
}

Get guest

Get a guest's contact details, tags and notes.

Inputs

GuestguesttextRequired
The guest's ID, from another Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.

Outputs

created_attext
When they were added to Guesty (ISO 8601)
emailtext
Their main email
first_nametext
Their first name
full_nametext
Their full name
good_to_know_notestext
Good-to-know notes about them
hometowntext
Where they live
idtext
The guest's ID
last_nametext
Their last name
notestext
Notes for the team about them
other_emailslist
Their other emails
other_phoneslist
Their other phone numbers
phonetext
Their main phone number
preferred_languagetext
Their language, as a two-letter code
returning_guesttrue/false
Whether they've stayed before
tagslist
Their tags, such as vip
Example output
{
  "created_at": "2022-08-12T16:00:00.000+03:00",
  "email": "email@email.com",
  "first_name": "Rick",
  "full_name": "Rick Sanchez",
  "good_to_know_notes": "This guest is allergic to peanuts",
  "hometown": "New York",
  "id": "5e17287629e111001f7d3f4d",
  "last_name": "Sanchez",
  "notes": "This guest is rich",
  "other_emails": [],
  "other_phones": [],
  "phone": "972234567454",
  "preferred_language": "en",
  "returning_guest": false,
  "tags": [
    "vip"
  ]
}

Get listing

Get a listing's title, address, check-in and check-out times, base price and stay limits.

Inputs

ListinglistingtextRequired
The listing.

Outputs

accommodatesnumber
How many guests it sleeps
activetrue/false
Whether it's active in Guesty
addresstext
Its full address
base_pricenumber
Its base price a night
bedroomsnumber
How many bedrooms it has
check_in_timetext
Its usual check-in time (HH:MM)
check_out_timetext
Its usual check-out time (HH:MM)
citytext
Its city
cleaning_feenumber
Its cleaning fee
countrytext
Its country
created_attext
When it was added to Guesty (ISO 8601)
currencytext
The currency of its prices
idtext
The listing's ID
listedtrue/false
Whether it's listed on booking channels
max_nightsnumber
Its longest stay, in nights
min_nightsnumber
Its shortest stay, in nights
nicknametext
Its nickname, as the team sees it
picturetext
A link to its main picture
property_typetext
Its property type, such as Apartment
room_typetext
Its room type, such as Entire home/apt
tagslist
Its tags
timezonetext
Its time zone, such as Europe/London
titletext
Its title, as guests see it
Example output
{
  "accommodates": 4,
  "active": true,
  "address": "Kaplan St 2, Ramat Gan, Israel",
  "base_price": 150,
  "bedrooms": 2,
  "check_in_time": "15:00",
  "check_out_time": "11:00",
  "city": "Ramat Gan",
  "cleaning_fee": 50,
  "country": "Israel",
  "created_at": "2017-09-03T15:48:45.070Z",
  "currency": "USD",
  "id": "59ac245d27cb310f0017afe3",
  "listed": true,
  "max_nights": 30,
  "min_nights": 1,
  "nickname": "Kaplan 2",
  "picture": "https://res.cloudinary.com/guesty/image/upload/c_fit,w_756/v1659982852/listing.jpg",
  "property_type": "Apartment",
  "room_type": "Entire home/apt",
  "tags": [
    "Pool"
  ],
  "timezone": "Asia/Jerusalem",
  "title": "Cozy luxurious loft"
}

Get listing calendar

Get a listing's availability, nightly price and minimum stay for each day between two dates, up to 366 days.

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 are listed
dayslist
Each day in the range, the first first
listing_idtext
The listing's ID
Example output
{
  "available_days": 1,
  "count": 1,
  "days": [
    {
      "available": true,
      "closed_to_arrival": false,
      "closed_to_departure": false,
      "currency": "USD",
      "date": "2023-06-14",
      "min_nights": 1,
      "price": 50,
      "reservation_id": "",
      "status": "available"
    }
  ],
  "listing_id": "62e17bddae108b003b1f87d7"
}

Get owner

Get a property owner's contact details and the listings they own.

Inputs

OwnerownertextRequired
The owner's ID, from another Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.

Outputs

activetrue/false
Whether they're active
addresstext
Their address
created_attext
When they were added to Guesty (ISO 8601)
emailtext
Their email
first_nametext
Their first name
full_nametext
Their full name
idtext
The owner's ID
last_nametext
Their last name
listing_idslist
The IDs of the listings they own
notestext
Notes about them
phonetext
Their phone number
Example output
{
  "active": true,
  "address": "",
  "created_at": "2021-08-18T12:44:07.000Z",
  "email": "example@email.com",
  "first_name": "John",
  "full_name": "John Doe",
  "id": "611d02b7c9c54b01736ae01d",
  "last_name": "Doe",
  "listing_ids": [
    "5f92cbf10cf217478ba93561"
  ],
  "notes": "",
  "phone": ""
}

Get reservation

Get a reservation's dates, guests, status, door code and notes, and its guest conversation for sending messages.

Inputs

ReservationreservationtextRequired
The reservation's ID, from another Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.

Outputs

adultsnumber
How many adults; empty if not given
booking_datetext
When it was booked (ISO 8601)
canceled_attext
When it was cancelled (ISO 8601); empty if not shown
channeltext
The channel it was booked through
check_intext
The check-in date in the listing's time zone (YYYY-MM-DD)
check_in_attext
When the guest is due to arrive (ISO 8601, UTC)
check_outtext
The check-out date in the listing's time zone (YYYY-MM-DD)
check_out_attext
When the guest is due to leave (ISO 8601, UTC)
childrennumber
How many children; empty if not given
cleaning_notetext
The note for cleaning
confirmation_codetext
Its confirmation code
confirmed_attext
When it was confirmed (ISO 8601); empty if not shown
conversation_idtext
The ID of its guest conversation, for sending messages; empty if not shown
created_attext
When it entered Guesty (ISO 8601)
guest_idtext
The ID of the guest who booked
guest_notetext
The note about the guest
guests_countnumber
How many guests are staying
idtext
The reservation's ID
infantsnumber
How many infants; empty if not given
key_codetext
The door or key code kept on it
listing_idtext
The ID of the listing it's for
nightsnumber
How many nights the stay is
other_notetext
Other notes
petsnumber
How many pets; empty if not given
sourcetext
Where it came from, such as airbnb, booking.com or manual
special_requeststext
The guest's special requests
statustext
Its status as Guesty stores it, such as confirmed, inquiry or canceled
status_labeltext
Its status as Guesty shows it
Example output
{
  "adults": 2,
  "booking_date": "2026-01-01T00:00:00.000Z",
  "canceled_at": "",
  "channel": "manual",
  "check_in": "2026-01-15",
  "check_in_at": "2026-01-15T14:00:00.000Z",
  "check_out": "2026-01-20",
  "check_out_at": "2026-01-20T11:00:00.000Z",
  "children": 0,
  "cleaning_note": "Cleaning notes",
  "confirmation_code": "ABC123",
  "confirmed_at": "2026-01-01T00:05:00.000Z",
  "conversation_id": "615997c2e74f61003015ab02",
  "created_at": "2026-01-01T00:00:00.000Z",
  "guest_id": "65aff36cbf774b59c718a0c8",
  "guest_note": "Guest notes",
  "guests_count": 2,
  "id": "65aff36cbf774b59c718a0c7",
  "infants": 0,
  "key_code": "123456",
  "listing_id": "6213b03e7f0ba50032296f4a",
  "nights": 5,
  "other_note": "Other notes",
  "pets": 0,
  "source": "manual",
  "special_requests": "Special request",
  "status": "confirmed",
  "status_label": "Confirmed"
}

Get task

Get a task's status, times, assignee and checklist.

Inputs

TasktasktextRequired
The task's ID, from another Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.

Outputs

assignee_idtext
The ID of the team member doing it
can_start_aftertext
The start of its window (ISO 8601)
checklistlist
Its checklist items
created_bytext
The ID of the team member who added it
descriptiontext
What it involves
idtext
The task's ID
listing_idtext
The ID of the listing it's for
listing_titletext
That listing's title; empty if not shown
must_finish_beforetext
The end of its window (ISO 8601)
prioritytext
Its priority: low, medium or high
reservation_idtext
The ID of the reservation it's for; empty if none
short_idtext
Its short ID, for quick reference
start_timetext
When it starts (ISO 8601); empty for a window
statustext
Its status: pending, confirmed, in progress, completed or canceled
supervisor_idtext
The ID of the team member supervising it
titletext
What it's called
typetext
Its type, such as cleaning or maintenance
Example output
{
  "assignee_id": "611d02b7c9c54b01736ae01d",
  "can_start_after": "",
  "checklist": [
    "Change linen",
    "Restock coffee"
  ],
  "created_by": "611d02b7c9c54b01736ae01d",
  "description": "Full clean after check-out.",
  "id": "66851bfe7ac4c20e71804f09",
  "listing_id": "5f92cbf10cf217478ba93561",
  "listing_title": "",
  "must_finish_before": "",
  "priority": "medium",
  "reservation_id": "",
  "short_id": "T-1042",
  "start_time": "2026-01-20T11:00:00.000Z",
  "status": "pending",
  "supervisor_id": "",
  "title": "Turnover clean",
  "type": "cleaning"
}

List conversation messages

List the latest messages and notes in a guest conversation, the newest first.

Inputs

ConversationconversationtextRequired
The conversation's ID, from 'Find conversations', a reservation's conversation ID, or the new guest message trigger.
Guest messages onlyguest_onlytrue/false
Leave out the team's.

Outputs

conversation_idtext
The conversation's ID
countnumber
How many are listed
messageslist
The messages, the newest first
Example output
{
  "conversation_id": "615997c2e74f61003015ab02",
  "count": 1,
  "messages": [
    {
      "body": "This is new note(COM postman)",
      "channel": "note",
      "conversation_id": "615997c2e74f61003015ab02",
      "created_at": "2021-10-11T12:54:43.248Z",
      "from_guest": false,
      "from_name": "COM - postman",
      "id": "61643413c9cf7a002d929325",
      "sent_by": "user"
    }
  ]
}

List owners

List the property owners in Guesty, with the listings each owns.

Inputs

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

Outputs

countnumber
How many are listed
ownerslist
The owners
Example output
{
  "count": 1,
  "owners": [
    {
      "active": true,
      "address": "",
      "created_at": "2021-08-18T12:44:07.000Z",
      "email": "example@email.com",
      "first_name": "John",
      "full_name": "John Doe",
      "id": "611d02b7c9c54b01736ae01d",
      "last_name": "Doe",
      "listing_ids": [
        "5f92cbf10cf217478ba93561"
      ],
      "notes": "",
      "phone": ""
    }
  ]
}

Send message to guest

Send the guest a message in their conversation, through their booking channel, email, text or WhatsApp. The guest receives it.

Inputs

ConversationconversationtextRequired
The conversation's ID, from 'Find conversations', a reservation's conversation ID, or the new guest message trigger.
MessagebodytextRequired
What to say.
Send bychanneltext
How it reaches the guest.One of: platform (Booking channel (Airbnb, Booking.com or email)), email, sms (Text message (SMS)), whatsapp. Default: platform.

Outputs

bodytext
What it says
channeltext
How it was sent, such as email, sms, airbnb2 or note
conversation_idtext
Its conversation's ID
created_attext
When it was sent (ISO 8601)
from_guesttrue/false
Whether the guest sent it
from_nametext
The name of the team member who sent it; empty if none
idtext
The message's ID
sent_bytext
Who sent it: guest, host or log
Example output
{
  "body": "This is new message(COM postman)",
  "channel": "email",
  "conversation_id": "615997c2e74f61003015ab02",
  "created_at": "2021-10-11T14:01:33.224Z",
  "from_guest": false,
  "from_name": "COM - postman",
  "id": "616443bdc9cf7a002d92933e",
  "sent_by": "user"
}

Update guest

Change a guest's details. Fields left blank keep what they have.

Inputs

GuestguesttextRequired
The guest's ID, from another Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.
First namefirst_nametext
Their first name.
Last namelast_nametext
Their last name.
Emailemailtext
Their main email.
Phonephonetext
Their main phone number with its country code, such as +14155550134.
Hometownhometowntext
Where they live, such as New York.
Notesnotestext
What the team should know about them for every stay.
Tagstagslist
Tags to give them. They replace the guest's current tags.One or more of: vip, friendsAndFamily (Friends and family), loyaltyProgram (Loyalty program), staff, management, blocklisted.
Preferred languagepreferred_languagetext
Their language as a two-letter code, such as en or es.

Outputs

created_attext
When they were added to Guesty (ISO 8601)
emailtext
Their main email
first_nametext
Their first name
full_nametext
Their full name
good_to_know_notestext
Good-to-know notes about them
hometowntext
Where they live
idtext
The guest's ID
last_nametext
Their last name
notestext
Notes for the team about them
other_emailslist
Their other emails
other_phoneslist
Their other phone numbers
phonetext
Their main phone number
preferred_languagetext
Their language, as a two-letter code
returning_guesttrue/false
Whether they've stayed before
tagslist
Their tags, such as vip
Example output
{
  "created_at": "2022-08-12T16:00:00.000+03:00",
  "email": "email@email.com",
  "first_name": "Rick",
  "full_name": "Rick Sanchez",
  "good_to_know_notes": "This guest is allergic to peanuts",
  "hometown": "New York",
  "id": "5e17287629e111001f7d3f4d",
  "last_name": "Sanchez",
  "notes": "This guest is rich",
  "other_emails": [],
  "other_phones": [],
  "phone": "972234567454",
  "preferred_language": "en",
  "returning_guest": false,
  "tags": [
    "vip"
  ]
}

Update listing calendar

Block or open a listing's days, or set their nightly price or minimum stay. Booking channels get the change too.

Inputs

ListinglistingtextRequired
The listing.
Fromstart_datedateRequired
The first day to change.
Toend_datedateRequired
The last day to change.
Availabilityavailabilitytext
Block the days or open them. Leave blank to keep it.One of: available, unavailable (Blocked).
Block reasonblock_reasontext
Why the days are blocked, when blocking them.One of: Maintenance, Owner block, Do not sell, Emergency out of order, Onboarding, Offboarded, Deactivated, Migrated unit block, Other.
Nightly pricepricenumber
The price a night, in the listing's currency.At least 0.
Use base priceuse_base_pricetrue/false
Set the days back to the listing's base price.
Minimum staymin_nightsnumber
The fewest nights a stay starting on these days can be.From 1 to 365.
Notenotetext
A note on the days, for the team.

Outputs

availabilitytext
available or unavailable; empty if unchanged
base_pricetrue/false
Whether the days went back to the base price
end_datetext
The last day changed (YYYY-MM-DD)
listing_idtext
The listing's ID
min_nightsnumber
The shortest stay set; empty if unchanged
notetext
The note added; empty if none
pricenumber
The price a night set; empty if unchanged
start_datetext
The first day changed (YYYY-MM-DD)
Example output
{
  "availability": "unavailable",
  "base_price": false,
  "end_date": "2023-02-01",
  "listing_id": "62e17bddae108b003b1f87d7",
  "min_nights": null,
  "note": "this is a note",
  "price": null,
  "start_date": "2023-01-01"
}

Update reservation notes

Set a reservation's door code, special requests or notes. Fields left blank keep what they have.

Inputs

ReservationreservationtextRequired
The reservation's ID, from another Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.
Key codekey_codetext
The door or lock box code to keep on the reservation, such as 123456.
Special requestsspecial_requeststext
The guest's special requests.
Guest noteguest_notetext
A note about the guest.
Cleaning notecleaning_notetext
A note for the cleaners.
Other noteother_notetext
Any other note.

Outputs

adultsnumber
How many adults; empty if not given
booking_datetext
When it was booked (ISO 8601)
canceled_attext
When it was cancelled (ISO 8601); empty if not shown
channeltext
The channel it was booked through
check_intext
The check-in date in the listing's time zone (YYYY-MM-DD)
check_in_attext
When the guest is due to arrive (ISO 8601, UTC)
check_outtext
The check-out date in the listing's time zone (YYYY-MM-DD)
check_out_attext
When the guest is due to leave (ISO 8601, UTC)
childrennumber
How many children; empty if not given
cleaning_notetext
The note for cleaning
confirmation_codetext
Its confirmation code
confirmed_attext
When it was confirmed (ISO 8601); empty if not shown
conversation_idtext
The ID of its guest conversation, for sending messages; empty if not shown
created_attext
When it entered Guesty (ISO 8601)
guest_idtext
The ID of the guest who booked
guest_notetext
The note about the guest
guests_countnumber
How many guests are staying
idtext
The reservation's ID
infantsnumber
How many infants; empty if not given
key_codetext
The door or key code kept on it
listing_idtext
The ID of the listing it's for
nightsnumber
How many nights the stay is
other_notetext
Other notes
petsnumber
How many pets; empty if not given
sourcetext
Where it came from, such as airbnb, booking.com or manual
special_requeststext
The guest's special requests
statustext
Its status as Guesty stores it, such as confirmed, inquiry or canceled
status_labeltext
Its status as Guesty shows it
Example output
{
  "adults": 2,
  "booking_date": "2026-01-01T00:00:00.000Z",
  "canceled_at": "",
  "channel": "manual",
  "check_in": "2026-01-15",
  "check_in_at": "2026-01-15T14:00:00.000Z",
  "check_out": "2026-01-20",
  "check_out_at": "2026-01-20T11:00:00.000Z",
  "children": 0,
  "cleaning_note": "Cleaning notes",
  "confirmation_code": "ABC123",
  "confirmed_at": "2026-01-01T00:05:00.000Z",
  "conversation_id": "615997c2e74f61003015ab02",
  "created_at": "2026-01-01T00:00:00.000Z",
  "guest_id": "65aff36cbf774b59c718a0c8",
  "guest_note": "Guest notes",
  "guests_count": 2,
  "id": "65aff36cbf774b59c718a0c7",
  "infants": 0,
  "key_code": "123456",
  "listing_id": "6213b03e7f0ba50032296f4a",
  "nights": 5,
  "other_note": "Other notes",
  "pets": 0,
  "source": "manual",
  "special_requests": "Special request",
  "status": "confirmed",
  "status_label": "Confirmed"
}

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 Guesty step or the trigger, such as 5f92cbf10cf217478ba93561.
Titletitletext
A new title.
Descriptiondescriptiontext
What it involves.
Statusstatustext
Where it stands.One of: pending, confirmed, in progress, completed, canceled (Cancelled).
Typetask_typetext
What kind of task it is.One of: cleaning, maintenance, inspection, check-in, mid-stay, runner, sanitation, issue, inventory, administration.
Priorityprioritytext
How urgent it is. Leave blank for Medium on a new task.One of: low, medium, high.
Assigneeassigneetext
The team member who does it.
Start timestart_timedate and time
When it must start. Leave blank to give a window instead.
Can start aftercan_start_afterdate and time
The start of its window.
Must finish beforemust_finish_beforedate and time
The end of its window.
Checklistchecklisttext
Items to tick off, one per line.
Planned hoursplanned_hoursnumber
How many hours it should take, such as 1.5.At least 0.

Outputs

assignee_idtext
The ID of the team member doing it
can_start_aftertext
The start of its window (ISO 8601)
checklistlist
Its checklist items
created_bytext
The ID of the team member who added it
descriptiontext
What it involves
idtext
The task's ID
listing_idtext
The ID of the listing it's for
listing_titletext
That listing's title; empty if not shown
must_finish_beforetext
The end of its window (ISO 8601)
prioritytext
Its priority: low, medium or high
reservation_idtext
The ID of the reservation it's for; empty if none
short_idtext
Its short ID, for quick reference
start_timetext
When it starts (ISO 8601); empty for a window
statustext
Its status: pending, confirmed, in progress, completed or canceled
supervisor_idtext
The ID of the team member supervising it
titletext
What it's called
typetext
Its type, such as cleaning or maintenance
Example output
{
  "assignee_id": "611d02b7c9c54b01736ae01d",
  "can_start_after": "",
  "checklist": [
    "Change linen",
    "Restock coffee"
  ],
  "created_by": "611d02b7c9c54b01736ae01d",
  "description": "Full clean after check-out.",
  "id": "66851bfe7ac4c20e71804f09",
  "listing_id": "5f92cbf10cf217478ba93561",
  "listing_title": "",
  "must_finish_before": "",
  "priority": "medium",
  "reservation_id": "",
  "short_id": "T-1042",
  "start_time": "2026-01-20T11:00:00.000Z",
  "status": "pending",
  "supervisor_id": "",
  "title": "Turnover clean",
  "type": "cleaning"
}

On this page