# Lodgify

> Run your Lodgify vacation rentals: check availability, rates and quotes, create and confirm bookings, record check-ins, set door codes, make payment links and message guests.

App · 19 actions. Web page: https://docs.lodol.com/docs/integrations/lodgify

## Actions

### Change booking status

Move a booking to Booked, Tentative, Open or Declined. Booked blocks the dates, and can ask the guest to pay what is due.

**Inputs**

- Booking ID (`booking_id`, text, required): The booking's number, from 'List bookings', a trigger or an earlier step.
- New status (`status`, text, required): The status to move the booking to. One of: `Booked`, `Tentative`, `Open`, `Declined`.
- Email the guest a payment request (`request_payment`, true/false): When confirming, email the guest asking for the amount due. Only when New status is Booked. Default: `false`.

**Outputs**

- `booking_id` (number): The booking's number
- `payment_requested` (true/false): Whether the guest was asked to pay
- `status` (text): The booking's new status

**Example output**

```json
{
  "booking_id": 12345678,
  "payment_requested": false,
  "status": "Booked"
}
```

### Create booking

Add a booking for a room type of a property, such as one taken by phone. Lodgify works out the price unless a total is given, and blocks the dates once it is Booked.

**Inputs**

- Property (`property_id`, text, required): The rental property. Pick one, or give its id from an earlier step.
- Room type (`room_type_id`, text, required): The room type within the property. Most rentals have just one.
- Arrival (`arrival`, date, required): The day the guests arrive.
- Departure (`departure`, date, required): The day the guests leave.
- Guest first name (`first_name`, text, required): The guest's first name.
- Guest last name (`last_name`, text): The guest's last name.
- Guest email (`email`, text): The guest's email address.
- Guest phone (`phone`, text): The guest's phone number, with the country code.
- Adults (`adults`, number, required): How many adults are staying. From 1 to 50.
- Children (`children`, number): How many children are staying. From 0 to 50.
- Infants (`infants`, number): How many infants are staying. From 0 to 50.
- Pets (`pets`, number): How many pets are coming. From 0 to 50.
- Status (`status`, text): The booking's status. To be sure it is applied, follow with 'Change booking status'. One of: `Booked`, `Tentative`, `Open`, `Declined`.
- Booking type (`bookability`, text): Instant booking, a booking request awaiting your answer, or an enquiry only. Lodgify treats a booking without one as an enquiry. One of: `InstantBooking` (Instant booking), `BookingRequest` (Booking request), `EnquiryOnly` (Enquiry only).
- Total price (`total`, number): The total for the stay. Leave empty to let Lodgify work it out from your rates. At least 0.
- Currency (`currency_code`, text): The three-letter currency of the total, such as EUR.
- Source (`source_text`, text): Where the booking came from, such as Phone or Walk-in.

**Outputs**

- `booking_id` (number): The new booking's number, for the other steps
- `status` (text): The status asked for, empty if none

**Example output**

```json
{
  "booking_id": 12345678,
  "status": "Booked"
}
```

### Create payment link

Make a payment page for an amount, in the booking's currency, to send to the guest yourself. Nothing is sent or charged.

**Inputs**

- Booking ID (`booking_id`, text, required): The booking's number, from 'List bookings', a trigger or an earlier step.
- Amount (`amount`, number, required): The amount to ask for, at least 0.01. At least 0.01.

**Outputs**

- `amount` (number): The amount asked for
- `booking_id` (number): The booking's number
- `url` (text): The payment page's address

**Example output**

```json
{
  "amount": 250.0,
  "booking_id": 12345678,
  "url": "https://checkout.lodgify.com/pay/abc123"
}
```

### Get availability

See which dates a property is free between two days: each period with how many units are available, and optionally the bookings that fill it.

**Inputs**

- Property (`property_id`, text, required): The rental property. Pick one, or give its id from an earlier step.
- Room type (`room_type_id`, text): Only this room type. Leave empty for all of them.
- From (`start_date`, date, required): The first day to include.
- Until (`end_date`, date, required): The last day to include.
- Include bookings (`include_bookings`, true/false): Also list the bookings in each period. Default: `false`.

**Outputs**

- `calendars` (list): One calendar per room type
- `count` (number): How many were returned

**Example output**

```json
{
  "calendars": [
    {
      "periods": [
        {
          "available": 1,
          "bookings": [],
          "end": "2026-12-19",
          "start": "2026-12-01"
        },
        {
          "available": 0,
          "bookings": [
            {
              "id": 12345678,
              "status": "Booked"
            }
          ],
          "end": "2026-12-26",
          "start": "2026-12-20"
        }
      ],
      "property_id": 412345,
      "room_type_id": 738408,
      "user_id": 99001
    }
  ],
  "count": 1
}
```

### Get booking

Get one booking with its guest, rooms and guest counts, door code, amounts paid and due, status and check-in times.

**Inputs**

- Booking ID (`booking_id`, text, required): The booking's number, from 'List bookings', a trigger or an earlier step.

**Outputs**

- `booking` (object): The booking

**Example output**

```json
{
  "booking": {
    "amount_due": 750.0,
    "amount_paid": 300.0,
    "arrival": "2026-12-20",
    "canceled_at": "",
    "check_in": {
      "initiator": "Owner",
      "time": "16:00:00"
    },
    "check_out": {
      "initiator": "Owner",
      "time": "10:00:00"
    },
    "created_at": "2026-10-15T09:00:00",
    "currency_code": "EUR",
    "departure": "2026-12-27",
    "guest": {
      "country_code": "GB",
      "email": "jo@example.com",
      "name": "Jo Bloggs",
      "phone": "+351912345678"
    },
    "id": 12345678,
    "is_deleted": false,
    "is_new": false,
    "language": "en",
    "notes": "Late arrival.",
    "property_id": 412345,
    "rooms": [
      {
        "guest_breakdown": {
          "adults": 2,
          "children": 1,
          "infants": 0,
          "pets": 0
        },
        "key_code": "4821",
        "people": 3,
        "room_type_id": 738408
      }
    ],
    "source": "Manual",
    "source_text": "Direct",
    "status": "Booked",
    "thread_uid": "6f1c2b9e-3a4d-4e5f-8a9b-0c1d2e3f4a5b",
    "total_amount": 1050.0,
    "updated_at": "2026-10-16T12:30:00"
  }
}
```

### Get booking messages

Read the conversation with a booking's guest, oldest message first.

**Inputs**

- Booking ID (`booking_id`, text, required): The booking's number, from 'List bookings', a trigger or an earlier step.

**Outputs**

- `booking_id` (number): The booking's number
- `count` (number): How many were returned
- `is_closed` (true/false): Whether the conversation can no longer take messages
- `messages` (list): The messages
- `thread_uid` (text): The conversation's id, empty if it has none

**Example output**

```json
{
  "booking_id": 12345678,
  "count": 1,
  "is_closed": false,
  "messages": [
    {
      "date_created": "2026-12-18T14:02:00",
      "id": 5551234,
      "is_read": true,
      "message": "We will arrive around 9pm.",
      "message_status": "Delivered",
      "route": "Email",
      "subject": "Arrival time",
      "type": "Renter"
    }
  ],
  "thread_uid": "6f1c2b9e-3a4d-4e5f-8a9b-0c1d2e3f4a5b"
}
```

### Get nightly rates

Get the price of each night between two days for a room type, with its minimum stay, and the property's rate settings (fees, taxes, check-in hours).

**Inputs**

- Property (`property_id`, text, required): The rental property. Pick one, or give its id from an earlier step.
- Room type (`room_type_id`, text, required): The room type within the property. Most rentals have just one.
- From (`start_date`, date, required): The first day to include.
- Until (`end_date`, date, required): The last day to include.

**Outputs**

- `calendar_items` (list): One entry per night
- `count` (number): How many were returned
- `rate_settings` (object): The rate settings

**Example output**

```json
{
  "calendar_items": [
    {
      "date": "2026-12-20",
      "is_default": false,
      "prices": [
        {
          "additional_guests_starts_from": 0,
          "max_stay": 30,
          "min_stay": 3,
          "price_per_additional_guest": 0.0,
          "price_per_day": 150.0
        }
      ]
    }
  ],
  "count": 1,
  "rate_settings": {
    "advance_notice_days": 1,
    "bookability": "InstantBooking",
    "booking_window_days": 365,
    "check_in_hour": 16,
    "check_out_hour": 10,
    "currency_code": "EUR",
    "fees": [
      {
        "fee_name": "Cleaning",
        "frequency": "PerStay"
      }
    ],
    "is_vat_exclusive": false,
    "preparation_time_days": 0,
    "promotions": [],
    "taxes": [],
    "vat": 0.0
  }
}
```

### Get payment link

Get the address of the page where a booking's guest pays what is due next.

**Inputs**

- Booking ID (`booking_id`, text, required): The booking's number, from 'List bookings', a trigger or an earlier step.

**Outputs**

- `booking_id` (number): The booking's number
- `url` (text): The payment page's address, empty if there is none

**Example output**

```json
{
  "booking_id": 12345678,
  "url": "https://checkout.lodgify.com/pay/abc123"
}
```

### Get property

Get one property with its address, description, prices and room types.

**Inputs**

- Property (`property_id`, text, required): The rental property. Pick one, or give its id from an earlier step.

**Outputs**

- `property` (object): The property

**Example output**

```json
{
  "property": {
    "address": "1 Harbour Road",
    "city": "Lagos",
    "country": "Portugal",
    "country_code": "PT",
    "created_at": "2025-03-01T10:00:00",
    "currency_code": "EUR",
    "description": "A two-bedroom cottage by the beach.",
    "id": 412345,
    "image_url": "https://l.icdbcdn.com/oh/seaview.jpg",
    "internal_name": "Seaview",
    "is_active": true,
    "latitude": 37.1,
    "longitude": -8.67,
    "max_price": 192.0,
    "min_price": 100.0,
    "name": "Seaview Cottage",
    "rating": 4.8,
    "rooms": [
      {
        "id": 738408,
        "name": "Whole cottage"
      }
    ],
    "state": "Faro",
    "updated_at": "2026-10-01T09:00:00",
    "zip": "8600-315"
  }
}
```

### Get quote

Work out what a stay would cost, with fees, taxes and the payment schedule, one quote per rate plan. Nothing is booked.

**Inputs**

- Property (`property_id`, text, required): The rental property. Pick one, or give its id from an earlier step.
- Room type (`room_type_id`, text, required): The room type within the property. Most rentals have just one.
- Arrival (`arrival`, date, required): The day the guests arrive.
- Departure (`departure`, date, required): The day the guests leave.
- Adults (`adults`, number, required): How many adults are staying. From 1 to 50.
- Children (`children`, number): How many children are staying. From 0 to 50.
- Infants (`infants`, number): How many infants are staying. From 0 to 50.
- Pets (`pets`, number): How many pets are coming. From 0 to 50.
- Promotion code (`promotion_code`, text): A promotion code to apply, as guests would type it.

**Outputs**

- `count` (number): How many were returned
- `quotes` (list): One quote per rate plan

**Example output**

```json
{
  "count": 1,
  "quotes": [
    {
      "amount_gross": 1100.0,
      "cancellation_policy_text": "Free cancellation until 30 days before arrival.",
      "currency_code": "EUR",
      "date_arrival": "2026-12-20T00:00:00",
      "date_departure": "2026-12-27T00:00:00",
      "property_id": 412345,
      "room_types": [
        {
          "name": "Whole cottage",
          "people": 2,
          "room_type_id": 738408,
          "subtotal": 1050.0
        }
      ],
      "scheduled_payments": [
        {
          "amount": 330.0,
          "date_due": "2026-10-20",
          "status": "Scheduled",
          "type": "PrePayment"
        }
      ],
      "security_deposit": 200.0,
      "total_excluding_vat": 1100.0,
      "total_including_vat": 1100.0,
      "total_vat": 0.0
    }
  ]
}
```

### List bookings

List bookings by when the stay is (upcoming, current, past, or arriving or leaving on a day), with the guest, dates, amounts and status.

**Inputs**

- Which bookings (`stay_filter`, text): Which stays to include. Defaults to upcoming stays. One of: `Upcoming` (Upcoming stays (default)), `Current` (Guests staying now), `Historic` (Past stays), `All` (All bookings), `ArrivalDate` (Arriving on a date), `DepartureDate` (Leaving on a date).
- Date (`stay_date`, date): The day guests arrive or leave, for 'Arriving on a date' or 'Leaving on a date'. Only when Which bookings is Arriving on a date or Leaving on a date.
- Changed since (`updated_since`, date and time): Only those created or changed after this moment.
- Trash (`trash`, text): Whether to include bookings in the trash. One of: `False` (Not in the trash (default)), `True` (Only the trash), `All` (Both).
- Include payments (`include_transactions`, true/false): Also return each booking's payments and refunds. Default: `false`.
- Include price breakdown (`include_quote_details`, true/false): Also return each booking's price breakdown and policy. Default: `false`.
- Page (`page`, number): Which page of results to return, starting at 1. At least 1.
- Page size (`page_size`, number): How many to return per page, 1 to 50. Lodgify's default is 50. From 1 to 50.

**Outputs**

- `bookings` (list): The bookings
- `count` (number): How many are on this page
- `page` (number): The page returned
- `total` (number): How many there are in all

**Example output**

```json
{
  "bookings": [
    {
      "amount_due": 750.0,
      "amount_paid": 300.0,
      "arrival": "2026-12-20",
      "canceled_at": "",
      "check_in": {
        "initiator": "Owner",
        "time": "16:00:00"
      },
      "check_out": {
        "initiator": "Owner",
        "time": "10:00:00"
      },
      "created_at": "2026-10-15T09:00:00",
      "currency_code": "EUR",
      "departure": "2026-12-27",
      "guest": {
        "country_code": "GB",
        "email": "jo@example.com",
        "name": "Jo Bloggs",
        "phone": "+351912345678"
      },
      "id": 12345678,
      "is_deleted": false,
      "is_new": false,
      "language": "en",
      "notes": "Late arrival.",
      "property_id": 412345,
      "rooms": [
        {
          "guest_breakdown": {
            "adults": 2,
            "children": 1,
            "infants": 0,
            "pets": 0
          },
          "key_code": "4821",
          "people": 3,
          "room_type_id": 738408
        }
      ],
      "source": "Manual",
      "source_text": "Direct",
      "status": "Booked",
      "thread_uid": "6f1c2b9e-3a4d-4e5f-8a9b-0c1d2e3f4a5b",
      "total_amount": 1050.0,
      "updated_at": "2026-10-16T12:30:00"
    }
  ],
  "count": 1,
  "page": 1,
  "total": 1
}
```

### List properties

List the rental properties in the Lodgify account with their address, prices and room types.

**Inputs**

- Changed since (`updated_since`, date and time): Only those created or changed after this moment.
- Page (`page`, number): Which page of results to return, starting at 1. At least 1.
- Page size (`page_size`, number): How many to return per page, 1 to 50. Lodgify's default is 50. From 1 to 50.

**Outputs**

- `count` (number): How many are on this page
- `page` (number): The page returned
- `properties` (list): The properties
- `total` (number): How many there are in all

**Example output**

```json
{
  "count": 1,
  "page": 1,
  "properties": [
    {
      "address": "1 Harbour Road",
      "city": "Lagos",
      "country": "Portugal",
      "country_code": "PT",
      "created_at": "2025-03-01T10:00:00",
      "currency_code": "EUR",
      "description": "A two-bedroom cottage by the beach.",
      "id": 412345,
      "image_url": "https://l.icdbcdn.com/oh/seaview.jpg",
      "internal_name": "Seaview",
      "is_active": true,
      "latitude": 37.1,
      "longitude": -8.67,
      "max_price": 192.0,
      "min_price": 100.0,
      "name": "Seaview Cottage",
      "rating": 4.8,
      "rooms": [
        {
          "id": 738408,
          "name": "Whole cottage"
        }
      ],
      "state": "Faro",
      "updated_at": "2026-10-01T09:00:00",
      "zip": "8600-315"
    }
  ],
  "total": 1
}
```

### List room types

List a property's room types (most rentals have one) with how many guests each sleeps, its bedrooms and amenities.

**Inputs**

- Property (`property_id`, text, required): The rental property. Pick one, or give its id from an earlier step.

**Outputs**

- `count` (number): How many were returned
- `property_id` (number): The property's id
- `room_types` (list): The room types

**Example output**

```json
{
  "count": 1,
  "property_id": 412345,
  "room_types": [
    {
      "adults_only": false,
      "area": 80.0,
      "area_unit": "m2",
      "bathrooms": 1,
      "bedrooms": 2,
      "breakfast_included": false,
      "description": "Sleeps four.",
      "has_parking": true,
      "has_wifi": true,
      "id": 738408,
      "image_url": "https://l.icdbcdn.com/oh/seaview-room.jpg",
      "max_people": 4,
      "max_price": 192.0,
      "min_price": 100.0,
      "name": "Whole cottage",
      "pets_allowed": false,
      "units": 1
    }
  ]
}
```

### Move booking to trash

Move a booking to Lodgify's trash, freeing its dates. It can be brought back with 'Restore booking'.

**Inputs**

- Booking ID (`booking_id`, text, required): The booking's number, from 'List bookings', a trigger or an earlier step.

**Outputs**

- `booking_id` (number): The booking's number
- `in_trash` (true/false): Whether the booking is now in the trash

**Example output**

```json
{
  "booking_id": 12345678,
  "in_trash": true
}
```

### Record check-in

Record the time a booking's guests checked in.

**Inputs**

- Booking ID (`booking_id`, text, required): The booking's number, from 'List bookings', a trigger or an earlier step.
- Time (`time`, time, required): The time of day, in the property's own time zone.

**Outputs**

- `booking_id` (number): The booking's number
- `time` (text): The time recorded, HH:MM:SS in the property's time zone

**Example output**

```json
{
  "booking_id": 12345678,
  "time": "16:30:00"
}
```

### Record check-out

Record the time a booking's guests checked out.

**Inputs**

- Booking ID (`booking_id`, text, required): The booking's number, from 'List bookings', a trigger or an earlier step.
- Time (`time`, time, required): The time of day, in the property's own time zone.

**Outputs**

- `booking_id` (number): The booking's number
- `time` (text): The time recorded, HH:MM:SS in the property's time zone

**Example output**

```json
{
  "booking_id": 12345678,
  "time": "10:00:00"
}
```

### Restore booking

Bring a booking back from Lodgify's trash.

**Inputs**

- Booking ID (`booking_id`, text, required): The booking's number, from 'List bookings', a trigger or an earlier step.

**Outputs**

- `booking_id` (number): The booking's number
- `in_trash` (true/false): Whether the booking is now in the trash

**Example output**

```json
{
  "booking_id": 12345678,
  "in_trash": false
}
```

### Send booking message

Send the guest of a booking a message, or add a private note to the booking's conversation that the guest never sees.

**Inputs**

- Booking ID (`booking_id`, text, required): The booking's number, from 'List bookings', a trigger or an earlier step.
- Message (`message`, text, required): The text of the message or note.
- Subject (`subject`, text): A subject line.
- Kind (`message_type`, text): A message to the guest, or a private note. One of: `Owner` (Message to the guest (default)), `Comment` (Private note (the guest never sees it)). Default: `Owner`.
- Notify the guest (`notify_guest`, true/false): Email the guest, or pass the message to the site they booked on, so they see it. Only when Kind is Message to the guest (default). Default: `true`.

**Outputs**

- `booking_id` (number): The booking's number
- `message_id` (text): The message's own id
- `type` (text): Owner for a message to the guest, Comment for a note

**Example output**

```json
{
  "booking_id": 12345678,
  "message_id": "0b4e8c1a-7d2f-4f3e-9a6b-5c4d3e2f1a0b",
  "type": "Owner"
}
```

### Set door code

Set the door or lockbox code a booking's guests use to get into the rental.

**Inputs**

- Booking ID (`booking_id`, text, required): The booking's number, from 'List bookings', a trigger or an earlier step.
- Code (`key_code`, text, required): The code or PIN.
- Room type ID (`room_type_id`, text): Only this room type of the booking. Leave empty to set the code on every room.

**Outputs**

- `booking_id` (number): The booking's number
- `count` (number): How many were returned
- `rooms` (list): The rooms and their codes

**Example output**

```json
{
  "booking_id": 12345678,
  "count": 1,
  "rooms": [
    {
      "key_code": "4821",
      "room_type_id": 738408
    }
  ]
}
```
