Lodgify

https://docs.lodgify.com/
Admin
Lodgify is a REST API platform for property management that enables seamless integrations for...
Tokens:41,602
Snippets:239
Trust Score:9.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Retrieve property information via cURL

Source: https://docs.lodgify.com/reference/getpropertybyid

Example request to fetch property details using the GET method.

```Shell
curl --request GET \
     --url https://api.lodgify.com/v1/properties/id \
     --header 'accept: text/plain'
```

--------------------------------

### Retrieve Property Availability via cURL

Source: https://docs.lodgify.com/reference/getcalendarbyproperty

Example request to fetch availability data for a specific property using the GET method.

```Shell
curl --request GET \
     --url 'https://api.lodgify.com/v2/availability/propertyId?includeDetails=false' \
     --header 'accept: text/plain'
```

--------------------------------

### GET https://api.lodgify.com/v2/properties/{id}

Source: https://docs.lodgify.com/reference/getpropertybyidv2

Get the basic info for a given property.

```APIDOC
## GET https://api.lodgify.com/v2/properties/{id}

### Description
Get the basic info for a given property.

### Method
GET

### Endpoint
https://api.lodgify.com/v2/properties/{id}

### Parameters
#### Path Parameters
- **id** (int32) - Required - Property identifier

#### Query Parameters
- **wid** (int32) - Optional - Optional website identifier for localized content
- **includeInOut** (boolean) - Optional - Defaults to false. If true, includes available dates for arrival or departure

### Response
#### Success Response (200)
- **id** (int32) - property identifier
- **name** (string) - Name of the property
- **internal_name** (string) - Internal name of property
- **description** (string) - Description of the property
- **latitude** (double) - Latitude coordinate of the house
- **longitude** (double) - Longitude coordinate of the house
- **address** (string) - Address of the property
- **hide_address** (boolean) - Owner requested to hide address from public
- **zip** (string) - Zip code for the property
- **city** (string) - City name where the property is located
- **state** (string) - Region name where the property is located
- **country_code** (string) - Two Letters Country Code where the property is located
- **country** (string) - Country name where the property is located
- **image_url** (string) - Image Url
- **has_addons** (boolean) - Boolean indicating if the property has available addons
- **has_agreement** (boolean) - Has agreement
- **agreement_text** (string) - Agreement text
- **agreement_url** (string) - Agreement url
- **contact** (object) - Contact information
- **spoken_languages** (array) - Spoken languages
- **rating** (double) - Rating
- **price_unit_in_days** (int32) - Price unit in days
- **min_price** (double) - Minimum price
- **original_min_price** (double) - Original minimum price
- **max_price** (double) - Maximum price
- **original_max_price** (double) - Original maximum price
- **rooms** (array) - List of rooms
- **in_out_max_date** (date-time) - Maximum date for in/out
- **in_out** (object) - In/out availability details
- **currency_code** (string) - Currency code
- **created_at** (date-time) - DateTime of creation
- **updated_at** (date-time) - Last update datetime
- **is_active** (boolean) - Boolean indicating if the property is active or not
- **subscription_plans** (array) - Subscription plans
```

--------------------------------

### GET /v2/rates/settings

Source: https://docs.lodgify.com/reference/ratesettings-v2

Retrieves the rate settings configuration.

```APIDOC
## GET /v2/rates/settings

### Description
Retrieves the current rate settings, including booking parameters, currency, VAT, fees, taxes, and promotions.

### Method
GET

### Endpoint
https://api.lodgify.com/v2/rates/settings

### Response
#### Success Response (200)
- **bookability** (integer) - Booking status
- **check_in_hour** (integer) - Check-in hour
- **check_out_hour** (integer) - Check-out hour
- **booking_window_days** (integer) - Booking window in days
- **advance_notice_days** (integer) - Advance notice in days
- **advance_notice_hours** (integer) - Advance notice in hours
- **preparation_time_days** (integer) - Preparation time in days
- **currency_code** (string) - Currency code
- **vat** (number) - VAT value
- **is_vat_exclusive** (boolean) - Whether VAT is exclusive
- **fees** (array) - List of fees
- **taxes** (array) - List of taxes
- **promotions** (array) - List of promotions

#### Response Example
{
  "bookability": 0,
  "check_in_hour": 0,
  "check_out_hour": 0,
  "booking_window_days": 0,
  "advance_notice_days": 0,
  "advance_notice_hours": 0,
  "preparation_time_days": 0,
  "currency_code": "string",
  "vat": 0,
  "is_vat_exclusive": true,
  "fees": [],
  "taxes": [],
  "promotions": []
}
```

--------------------------------

### cURL Request for Room Details

Source: https://docs.lodgify.com/reference/propertiesapi_get_get

Example request to retrieve room information using the cURL command-line tool.

```Shell
curl --request GET \
     --url https://api.lodgify.com/v1/properties/id/rooms/rid \
     --header 'accept: text/plain'
```

--------------------------------

### cURL Request for Currency by Code

Source: https://docs.lodgify.com/reference/currenciesapi_getbycode_get

Example request to fetch currency details using the cURL command-line tool.

```Shell
curl --request GET \
     --url https://api.lodgify.com/v1/currencies/code \
     --header 'accept: text/plain'
```

--------------------------------

### Example Response Body

Source: https://docs.lodgify.com/reference/getalldeletedasync

A sample JSON array response containing deleted property IDs.

```JSON
[
  0
]
```

--------------------------------

### Create a payment link cURL request

Source: https://docs.lodgify.com/reference/createpaymentlink-1

Example of a POST request to generate a payment link for a booking.

```Shell
curl --request POST \
     --url https://api.lodgify.com/v1/reservation/booking/id/quote/paymentLink \
     --header 'accept: text/plain' \
     --header 'content-type: application/json-patch+json'
```

--------------------------------

### GET https://api.lodgify.com/v2/rates/settings

Source: https://docs.lodgify.com/reference/ratesettings-v2

Retrieves the rate settings for a specified house ID.

```APIDOC
## GET https://api.lodgify.com/v2/rates/settings

### Description
Returns rate settings for the houseId.

### Method
GET

### Endpoint
https://api.lodgify.com/v2/rates/settings

### Parameters
#### Query Parameters
- **houseId** (int32) - Required - The ID of the house to retrieve settings for.

### Headers
- **accept** (string) - Optional - Defaults to application/json. Allowed values: application/json, text/json, text/plain
```

--------------------------------

### cURL Request for Get All Rooms

Source: https://docs.lodgify.com/reference/propertiesapi_v_getallrooms_get

Use this cURL command to perform a GET request to the rooms endpoint. Ensure the URL includes the correct property ID.

```Shell
curl --request GET \
     --url https://api.lodgify.com/v2/properties/id/rooms \
     --header 'accept: text/plain'
```

--------------------------------

### Retrieve Availability via cURL

Source: https://docs.lodgify.com/reference/get_v1-availability-propertyid-roomtypeid

Example request to fetch availability data for a specific property and room type.

```Shell
curl --request GET \
     --url https://api.lodgify.com/v1/availability/propertyId/roomTypeId \
     --header 'accept: text/plain'
```

--------------------------------

### Successful response body

Source: https://docs.lodgify.com/reference/createpaymentlinkasync

Example JSON response indicating a successful payment link creation.

```JSON
{
  "succeeded": true
}
```

--------------------------------

### cURL Request for creating a payment link

Source: https://docs.lodgify.com/reference/createpaymentlinkasync

Example request to the payment link endpoint using cURL.

```Shell
curl --request POST \
     --url https://api.lodgify.com/v2/reservations/bookings/id/quote/paymentLink \
     --header 'accept: text/plain' \
     --header 'content-type: application/json-patch+json'
```

--------------------------------

### Availability Response Body

Source: https://docs.lodgify.com/reference/get_v1-availability

Example JSON response structure for a successful availability query.

```JSON
[
  {
    "property_id": 0,
    "room_type_id": 0,
    "period_start": "2026-08-10T07:00:50.228Z",
    "period_end": "2026-08-10T07:00:50.228Z",
    "available": 0,
    "total_units": 0,
    "total_overbooked": 0,
    "is_available": true,
    "booking_ids": [
      0
    ],
    "closed_period_id": 0
  }
]
```

--------------------------------

### cURL Request for Country by Code

Source: https://docs.lodgify.com/reference/countriesapi_getbycode_get

Example request to fetch country details using the cURL command-line tool.

```Shell
curl --request GET \
     --url https://api.lodgify.com/v1/countries/code \
     --header 'accept: text/plain'
```

--------------------------------

### GET https://api.lodgify.com/v1/currencies

Source: https://docs.lodgify.com/reference/currenciesapi_list_get

Retrieves a list of available currencies in Lodgify.

```APIDOC
## GET https://api.lodgify.com/v1/currencies

### Description
Returns a list of available currencies in Lodgify.

### Method
GET

### Endpoint
https://api.lodgify.com/v1/currencies

### Parameters
#### Headers
- **accept** (string) - Optional - Defaults to application/json. Allowed: application/json, application/xml, text/json, text/plain, text/xml

### Response
#### Success Response (200)
- **array of objects** (object) - A list of currency objects.
  - **id** (int32) - Currency identifier
  - **code** (string | null) - Currency code
  - **name** (string | null) - Currency Name
  - **euro_forex** (double) - Exchange rate between currency and Euro
  - **symbol** (string | null) - Currency symbol
  - **decimal_places** (int32) - Number of decimal places for the currency

#### Response Example
[
  {
    "id": 0,
    "code": "string",
    "name": "string",
    "euro_forex": 0,
    "symbol": "string",
    "decimal_places": 0
  }
]
```

--------------------------------

### GET /properties/{id}/rooms/{rid}

Source: https://docs.lodgify.com/reference/propertiesapi_get_get

Retrieves details for a given room in a property.

```APIDOC
## GET https://api.lodgify.com/v1/properties/{id}/rooms/{rid}

### Description
Returns details for a given room in a property.

### Method
GET

### Endpoint
https://api.lodgify.com/v1/properties/{id}/rooms/{rid}

### Parameters
#### Path Parameters
- **id** (int32) - Required - Property Id
- **rid** (int32) - Required - Room Id

#### Query Parameters
- **wid** (int32) - Optional - If provided, it will return any localized text as if it was for the given website.

### Response
#### Success Response (200)
- **images** (array of objects) - List of room images
- **amenities** (object) - Room amenities
- **description** (string) - Room description
- **breakfast_included** (boolean) - Whether breakfast is included
- **has_parking** (boolean) - Whether parking is available
- **adults_only** (boolean) - Whether the room is adults only
- **pets_allowed** (boolean) - Whether pets are allowed
- **show_additional_key_facts** (boolean) - Whether to show additional key facts
- **id** (int32) - Room identifier
- **name** (string) - Room name
- **image_url** (string) - URL for the room image
- **max_people** (int32) - Maximum occupancy
- **units** (int32) - Number of units
- **has_wifi** (boolean) - Whether wifi is available
- **has_meal_plan** (boolean) - Whether a meal plan is available
- **bedrooms** (int32) - Number of bedrooms
- **bathrooms** (int32) - Number of bathrooms
- **area_unit** (string) - Unit of area measurement
- **area** (double) - Room area
- **min_price** (double) - Minimum price
- **original_min_price** (double) - Original minimum price
- **max_price** (double) - Maximum price
- **original_max_price** (double) - Original maximum price
- **price_unit_in_days** (int32) - Price unit in days
- **currency** (object) - Currency details
```

--------------------------------

### GET https://api.lodgify.com/v2/properties

Source: https://docs.lodgify.com/reference/getallpropertiesasync

Retrieves a paged list of all properties.

```APIDOC
## GET https://api.lodgify.com/v2/properties

### Description
Returns a paged list of all properties.

### Method
GET

### Endpoint
https://api.lodgify.com/v2/properties

### Parameters
#### Query Parameters
- **wid** (int32) - Optional - Website identifier for localized content
- **updatedSince** (date-time) - Optional - Datetime filter to include only properties modified since this date
- **includeCount** (boolean) - Optional - If true, returns the total number of results (default: false)
- **includeInOut** (boolean) - Optional - If true, includes available dates for arrival or departure (default: false)
- **page** (int32) - Optional - Page number to retrieve (default: 1)
- **size** (int32) - Optional - Number of items per page (max: 50, default: 50)

### Response
#### Success Response (200)
- **count** (int32) - Total number of items available (returned if includeCount = true)
- **items** (array) - List of properties for the current page
```

--------------------------------

### cURL request for batch marking as replied

Source: https://docs.lodgify.com/reference/post_v1-reservation-replied

Example of a POST request to the reservation replied endpoint using cURL.

```Shell
curl --request POST \
     --url https://api.lodgify.com/v1/reservation/replied \
     --header 'accept: application/json' \
     --header 'content-type: application/json-patch+json'
```

--------------------------------

### GET https://api.lodgify.com/webhooks/v1/list

Source: https://docs.lodgify.com/reference/webhooksapi_list_get

Retrieves a list of webhooks associated with the user.

```APIDOC
## GET https://api.lodgify.com/webhooks/v1/list

### Description
Retrieves a list of webhooks associated with the user.

### Method
GET

### Endpoint
https://api.lodgify.com/webhooks/v1/list

### Parameters
#### Query Parameters
- **accept** (string) - Optional - Defaults to application/json. Allowed: application/json, text/json, text/plain

### Response
#### Success Response (200)
- **id** (string) - The webhook ID
- **event** (string) - The event associated with the webhook
- **url** (uri) - The webhook URL

#### Response Example
[
  {
    "id": "string",
    "event": "string",
    "url": "string"
  }
]
```

--------------------------------

### Subscribe to a Webhook cURL Request

Source: https://docs.lodgify.com/reference/webhooksapi_subscribe_post

Example of a POST request to the subscription endpoint using cURL.

```bash
curl --request POST \
     --url https://api.lodgify.com/webhooks/v1/subscribe \
     --header 'accept: text/plain' \
     --header 'content-type: application/json-patch+json'
```

--------------------------------

### GET /v2/reservations/bookings

Source: https://docs.lodgify.com/reference/getallasync

Retrieves a list of reservations based on the provided query parameters.

```APIDOC
## GET /v2/reservations/bookings

### Description
Retrieves a paginated list of reservations. Supports filtering by page size and including additional details like transactions or quote information.

### Method
GET

### Endpoint
https://api.lodgify.com/v2/reservations/bookings

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **size** (integer) - Optional - The number of items per page.
- **includeCount** (boolean) - Optional - Whether to include the total count of items.
- **includeTransactions** (boolean) - Optional - Whether to include transaction details.
- **includeExternal** (boolean) - Optional - Whether to include external booking details.
- **includeQuoteDetails** (boolean) - Optional - Whether to include quote details.

### Response
#### Success Response (200)
- **count** (integer) - Total number of items.
- **items** (array) - List of reservation objects.

#### Response Example
{
  "count": 0,
  "items": [
    {
      "id": 0,
      "user_id": 0,
      "arrival": "string",
      "departure": "string",
      "property_id": 0,
      "status": "Open"
    }
  ]
}
```

--------------------------------

### GET /v1/quote/{propertyId}

Source: https://docs.lodgify.com/reference/get_v1-quote-propertyid-1

Calculates the price and details for a potential booking based on the provided parameters.

```APIDOC
## GET /v1/quote/{propertyId}

### Description
Calculates the price and details for a potential booking based on the provided parameters (dates, property, room types, etc.). Returns a list of quotes for different rate plans.

### Method
GET

### Endpoint
https://api.lodgify.com/v1/quote/{propertyId}

### Parameters
#### Path Parameters
- **propertyId** (int32) - Required - The unique identifier of the property.

#### Query Parameters
- **arrival** (date-time) - Optional - The arrival date of the stay.
- **departure** (date-time) - Optional - The departure date of the stay.
- **roomTypes** (array of objects) - Optional - A list of room types and the number of guests for each.
- **addOns** (array of objects) - Optional - Optional list of add-ons to include in the quote.
- **promotionCode** (string) - Optional - Optional promotion code to apply to the quote.

### Request Example
curl --request GET \
     --url https://api.lodgify.com/v1/quote/{propertyId}?roomTypes[0].Id={roomTypeId}&roomTypes[0].People={numberOfPeople}&roomTypes[0].guest_breakdown.adults={numberofAdults}&roomTypes[0].guest_breakdown.pets={numberofPets}&addOns[0].Id={addOnId}&addOns[0].Units={addOnUnits}' \
     --header 'X-ApiKey: YOUR_API_KEY' \
     --header 'accept: application/json'
```

--------------------------------

### Retrieve Availability cURL Request

Source: https://docs.lodgify.com/reference/get_v1-availability

Example request to the availability endpoint using cURL.

```Shell
curl --request GET \
     --url https://api.lodgify.com/v1/availability \
     --header 'accept: text/plain'
```

--------------------------------

### GET /properties/{id}/rooms

Source: https://docs.lodgify.com/reference/propertiesapi_v_getallrooms_get

Returns all the room types available for a given property.

```APIDOC
## GET https://api.lodgify.com/v2/properties/{id}/rooms

### Description
Returns all the room types available for a given property.

### Method
GET

### Endpoint
https://api.lodgify.com/v2/properties/{id}/rooms

### Parameters
#### Path Parameters
- **id** (int32) - Required - Property identifier

#### Query Parameters
- **wid** (int32) - Optional - Website identifier for localized content

### Response
#### Success Response (200)
- **array of objects** - List of available rooms

#### Response Fields
- **id** (int32) - Room identifier.
- **name** (string) - Name of the room.
- **image_url** (string) - URL address of the image of the room.
- **max_people** (int32) - Maximum number of people the room can host.
- **units** (int32) - Number of units (same room type) that this room has.
- **has_wifi** (boolean) - Indicates if the property has wifi available.
- **has_meal_plan** (boolean) - Indicates if the property has a meal plan available.
- **bedrooms** (int32) - Number of bedrooms in the room.
- **bathrooms** (int32) - Number of bathrooms in the room.
- **area_unit** (string) - Indicates if the area is given in square feet(sqf) or square meters(sqm).
- **area** (double) - Size of the unit.
- **min_price** (double) - Minimal price in euros.
- **original_min_price** (double) - Minimal price in the owner's currency.
- **max_price** (double) - Maximum price in euros.
- **original_max_price** (double) - Maximum price in the owner's currency.
- **price_unit_in_days** (int32) - Price unit in days.
- **images** (array) - List of images associated with the room.
- **amenities** (object) - List of amenities available for the room (includes description, breakfast_included, has_parking, adults_only, pets_allowed, show_additional_key_facts).
```

--------------------------------

### cURL Request for Setting Check-in Time

Source: https://docs.lodgify.com/reference/put_v1-reservation-booking-id-checkin

Example request to update the check-in time for a booking using the cURL command-line tool.

```Shell
curl --request PUT \
     --url https://api.lodgify.com/v1/reservation/booking/id/checkin \
     --header 'accept: application/json' \
     --header 'content-type: application/json-patch+json'
```

--------------------------------

### GET /v1/reservation

Source: https://docs.lodgify.com/reference/bookingslist-1

Retrieves a list of reservations based on provided query parameters.

```APIDOC
## GET /v1/reservation

### Description
Retrieves a paginated list of reservations from the system.

### Method
GET

### Endpoint
https://api.lodgify.com/v1/reservation

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - The number of items to skip before starting to collect the result set.
- **limit** (integer) - Optional - The maximum number of items to return.
- **trash** (boolean) - Optional - Whether to include items in the trash.

### Response
#### Success Response (200)
- **items** (array) - A list of reservation objects.

#### Response Example
{
  "items": [
    {
      "id": 0,
      "type": "string",
      "booking_type": "string",
      "status": "string",
      "source": "string",
      "source_text": "string",
      "guest": {
        "guest_name": {
          "first_name": "string",
          "last_name": "string",
          "full_name": "string"
        },
        "external_id": "string",
        "email": "string",
        "phone_numbers": ["string"],
        "locale": "string",
        "street_address1": "string",
        "street_address2": "string",
        "city": "string",
        "country_code": "string",
        "postal_code": "string",
        "state": "string",
        "id": "string",
        "country_name": "string"
      },
      "arrival": "string",
      "departure": "string",
      "total_guest_breakdown": {
        "adults": 0,
        "children": 0,
        "infants": 0,
        "pets": 0
      },
      "property_id": 0,
      "property_name": "string",
      "rooms": [
        {
          "room_type_id": 0
        }
      ]
    }
  ]
}
```

--------------------------------

### GET https://api.lodgify.com/v1/properties/{id}

Source: https://docs.lodgify.com/reference/getpropertybyid

Retrieves the basic information for a given property by its ID.

```APIDOC
## GET https://api.lodgify.com/v1/properties/{id}

### Description
Get the basic info for a given property.

### Method
GET

### Endpoint
https://api.lodgify.com/v1/properties/{id}

### Parameters
#### Path Parameters
- **id** (int32) - Required - Property identifier

#### Query Parameters
- **maxDate** (date-time) - Optional - Maximum date for check-in/check-out information
- **wid** (int32) - Optional - Website identifier for localized content

### Response
#### Success Response (200)
- **id** (int32) - Property identifier
- **name** (string) - Name of the property
- **address** (string) - Address of the property
- **zip** (string) - Zip code for the property
- **city** (string) - City name
- **country** (string) - Country name
- **image_url** (string) - Image Url
- **has_addons** (boolean) - Indicates if the property has available addons
- **has_agreement** (boolean) - Indicates if there is an agreement
- **rating** (double) - Property rating
- **min_price** (double) - Minimum price
- **max_price** (double) - Maximum price
- **rooms** (array) - List of room objects
```

--------------------------------

### 200 OK Response Body

Source: https://docs.lodgify.com/reference/get_v2-messaging-threadguid

Example JSON structure returned upon a successful request to the thread details endpoint.

```JSON
[
  {
    "thread_uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "guest_name": "string",
    "guest_email": "string",
    "last_message_date": "2026-08-10T07:01:09.712Z",
    "is_read": true,
    "messages": [
      {
        "id": 0,
        "subject": "string",
        "message": "string",
        "type": "string",
        "date_created": "2026-08-10T07:01:09.712Z",
        "attachments": [
          {
            "file_name": "string",
            "content_length": "string",
            "content_type": "string",
            "file_url": "string"
          }
        ],
        "message_status": "string",
        "is_read": true,
        "route": "Email",
        "is_imported": true,
        "message_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "is_closed": true,
    "error_message": "string",
    "error_title": "string"
  }
]
```

--------------------------------

### GET https://api.lodgify.com/v2/reservations/bookings

Source: https://docs.lodgify.com/reference/getallasync

Retrieve a list of bookings matching the provided query parameters.

```APIDOC
## GET https://api.lodgify.com/v2/reservations/bookings

### Description
Retrieve a list of bookings matching the query parameters.

### Method
GET

### Endpoint
https://api.lodgify.com/v2/reservations/bookings

### Parameters
#### Query Parameters
- **page** (int32) - Optional - Number of the page to retrieve (Defaults to 1)
- **size** (int32) - Optional - Number of items per page (Defaults to 50)
- **includeCount** (boolean) - Optional - Include number of all items (Defaults to false)
- **stayFilter** (string) - Optional - Filter Bookings by the stay dates (Allowed: Upcoming, Current, Historic, All, ArrivalDate, DepartureDate)
- **updatedSince** (date-time) - Optional - Include only Bookings updated since this date
- **includeTransactions** (boolean) - Optional - Include details about transactions and schedule (Defaults to false)
- **includeExternal** (boolean) - Optional - Include external details (Defaults to false)
- **includeQuoteDetails** (boolean) - Optional - Include quote details (Defaults to false)
- **trash** (string) - Optional - Query bookings that are in trash (Allowed: False, True, All)
- **stayFilterDate** (date-time) - Optional - Date to filter when selected ArrivalDate or DepartureDate in stayFilter

### Headers
- **accept** (string) - Optional - Defaults to application/json (Allowed: application/json, text/json, text/plain)
```

--------------------------------

### GET https://api.lodgify.com/v1/rates/calendar

Source: https://docs.lodgify.com/reference/ratescalendar

Returns a simplified nightly rates calendar for a rental, requested by houseId and roomTypeId.

```APIDOC
## GET https://api.lodgify.com/v1/rates/calendar

### Description
Returns a simplified nightly rates calendar for a rental, requested by houseId and roomTypeId. For a more detailed response, consider using the V2 version of this endpoint.

### Method
GET

### Endpoint
https://api.lodgify.com/v1/rates/calendar

### Parameters
#### Query Parameters
- **houseId** (int32) - Required - The ID of the house.
- **roomTypeId** (int32) - Required - The ID of the room type.
- **startDate** (string) - Required - The start date of the calendar (yyyy-MM-dd).
- **endDate** (string) - Required - The end date of the calendar (yyyy-MM-dd).

### Response
#### Success Response (200)
- **date** (string | null) - The date of the rate.
- **is_default** (boolean) - Indicates if the rate is a default rate.
- **prices** (array of objects | null) - List of price objects.
  - **min_stay** (int32) - Minimum stay requirement.
  - **max_stay** (int32) - Maximum stay requirement.
  - **price_per_day** (number) - The price for the day.

#### Response Example
[
  {
    "date": "string",
    "is_default": true,
    "prices": [
      {
        "min_stay": 0,
        "max_stay": 0,
        "price_per_day": 123.45
      }
    ]
  }
]
```

--------------------------------

### GET https://api.lodgify.com/v1/properties/{id}/payments

Source: https://docs.lodgify.com/reference/propertiesapi_listpaymentsettings_get

Returns a list of available payments for a given property.

```APIDOC
## GET https://api.lodgify.com/v1/properties/{id}/payments

### Description
Returns a list of available payments for a given property. This payment types are useful when creating bookings.

### Method
GET

### Endpoint
https://api.lodgify.com/v1/properties/{id}/payments

### Parameters
#### Path Parameters
- **id** (int32) - Required - Property identifier

### Response
#### Success Response (200)
- **id** (int32) - Payment identifier
- **payment_address** (string) - Payment address
- **payment_type** (string) - Payment type

#### Response Example
[
  {
    "id": 0,
    "payment_address": "string",
    "payment_type": "string"
  }
]
```

--------------------------------

### GET /v1/rates/calendar

Source: https://docs.lodgify.com/reference/rates

Retrieves a simplified nightly rates calendar for a rental property based on house and room type IDs.

```APIDOC
## GET /v1/rates/calendar

### Description
Returns a simplified nightly rates calendar for a rental, requested by houseId and roomTypeId. For a more detailed response, consider using the V2 version of this endpoint.

### Method
GET

### Endpoint
https://api.lodgify.com/v1/rates/calendar

### Parameters
#### Query Parameters
- **houseId** (int32) - Required - The ID of the house.
- **roomTypeId** (int32) - Required - The ID of the room type.
- **startDate** (string) - Required - The start date of the calendar (yyyy-MM-dd).
- **endDate** (string) - Required - The end date of the calendar (yyyy-MM-dd).

### Response
#### Success Response (200)
- **date** (string | null) - The date of the rate.
- **is_default** (boolean) - Indicates if the rate is a default rate.
- **prices** (array of objects | null) - List of price objects.
  - **min_stay** (int32) - Minimum stay requirement.
  - **max_stay** (int32) - Maximum stay requirement.
  - **price_per_day** (number) - The price for the day.

#### Response Example
[
  {
    "date": "string",
    "is_default": true,
    "prices": [
      {
        "min_stay": 0,
        "max_stay": 0,
        "price_per_day": 123.45
      }
    ]
  }
]
```

--------------------------------

### GET /v1/availability/{propertyId}

Source: https://docs.lodgify.com/reference/get_v1-availability-propertyid

Retrieves availability information for all room types within a specific property for a given date range.

```APIDOC
## GET /v1/availability/{propertyId}

### Description
Retrieves availability information for all room types within a specific property for a given date range.

### Method
GET

### Endpoint
https://api.lodgify.com/v1/availability/{propertyId}

### Parameters
#### Path Parameters
- **propertyId** (int32) - Required - The unique identifier of the property.

#### Query Parameters
- **periodStart** (date-time) - Optional - The start date of the period to check availability.
- **periodEnd** (date-time) - Optional - The end date of the period to check availability.
- **CombineRoomTypes** (boolean) - Optional - Indicates whether to combine results from different room types into a single house total.
- **BookingsOnly** (boolean) - Optional - Indicates whether to retrieve only booking information, excluding other availability details. This option is only valid for room type queries.
- **IncludeBookingIds** (boolean) - Optional - Indicates whether to include the list of booking identifiers in the response. This option is only valid for room type queries.
- **ModifiedSince** (date-time) - Optional - Filters the results to include only sub-periods modified after the specified date, up to 6 months prior to the current date. This option is only valid for room type queries.

### Response
#### Success Response (200)
- **property_id** (int32) - The unique identifier of the property associated with this availability period
- **room_type_id** (int32) - The unique identifier of the room type
- **period_start** (date-time) - The start date of the availability period
- **period_end** (date-time) - The end date of the availability period (inclusive)
- **available** (int32) - The number of units available during this period
- **total_units** (int32) - The total number of units for this room type
- **total_overbooked** (int32) - The total number of overbooked units for this room type
- **is_available** (boolean) - Indicates whether the period is available (not closed and has unoccupied units)
- **booking_ids** (array of int32s | null) - The list of booking identifiers associated with this period
- **closed_period_id** (int32 | null) - The identifier of the closed period, if applicable

#### Response Example
[
  {
    "property_id": 0,
    "room_type_id": 0,
    "period_start": "2026-08-10T07:00:51.444Z",
    "period_end": "2026-08-10T07:00:51.444Z",
    "available": 0,
    "total_units": 0,
    "total_overbooked": 0,
    "is_available": true,
    "booking_ids": [0],
    "closed_period_id": 0
  }
]
```

--------------------------------

### Retrieve Booking Details via cURL

Source: https://docs.lodgify.com/reference/getasync

Use this cURL command to perform a GET request for a specific reservation booking.

```Shell
curl --request GET \
     --url https://api.lodgify.com/v2/reservations/bookings/id \
     --header 'accept: text/plain'
```

--------------------------------

### GET https://api.lodgify.com/v1/properties

Source: https://docs.lodgify.com/reference/listproperties

Returns the list of completed properties for a given user. This is a protected endpoint.

```APIDOC
## GET https://api.lodgify.com/v1/properties

### Description
Returns the list of completed properties for a given user. This is a protected endpoint.

### Method
GET

### Endpoint
https://api.lodgify.com/v1/properties

### Parameters
#### Query Parameters
- **wid** (int32) - Optional - If provided, it will return any localized text as if it was for the given website.

### Response
#### Success Response (200)
- **id** (int32) - property identifier
- **name** (string | null) - Name of the property
- **latitude** (double) - Latitude coordinate of the house
- **longitude** (double) - Longitude coordinate of the house
- **rooms** (array of objects | null) - List of rooms of the property
- **subscription_plans** (array of strings | null) - Subscription plans

#### Response Example
[
  {
    "id": 0,
    "name": "string",
    "latitude": 0,
    "longitude": 0,
    "rooms": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "subscription_plans": [
      "string"
    ]
  }
]
```

--------------------------------

### GET https://api.lodgify.com/v1/currencies/{code}

Source: https://docs.lodgify.com/reference/currenciesapi_getbycode_get

Retrieves the currency details associated with the provided currency code.

```APIDOC
## GET https://api.lodgify.com/v1/currencies/{code}

### Description
Returns the currency with the given code.

### Method
GET

### Endpoint
https://api.lodgify.com/v1/currencies/{code}

### Parameters
#### Path Parameters
- **code** (string) - Required - Code of the currency you want

### Response
#### Success Response (200)
- **id** (int32) - Currency identifier
- **code** (string) - Currency code
- **name** (string) - Currency Name
- **euro_forex** (double) - Exchange rate between currency and Euro
- **symbol** (string) - Currency symbol
- **decimal_places** (int32) - Number of decimal places for the currency

#### Response Example
{
  "id": 0,
  "code": "string",
  "name": "string",
  "euro_forex": 0,
  "symbol": "string",
  "decimal_places": 0
}
```

--------------------------------

### Response Schema for Get All Rooms

Source: https://docs.lodgify.com/reference/propertiesapi_v_getallrooms_get

The response is an array of room objects containing property details, amenities, and pricing information.

```JSON
[
  {
    "images": [
      {
        "text": "string",
        "url": "string"
      }
    ],
    "amenities": {
      "additionalProp": [
        {
          "name": "string",
          "prefix": "string",
          "bracket": "string",
          "text": "string"
        }
      ]
    },
    "description": "string",
    "breakfast_included": true,
    "has_parking": true,
    "adults_only": true,
    "pets_allowed": true,
    "show_additional_key_facts": true,
    "id": 0,
    "name": "string",
    "image_url": "string",
    "max_people": 0,
    "units": 0,
    "has_wifi": true,
    "has_meal_plan": true,
    "bedrooms": 0,
    "bathrooms": 0,
    "area_unit": "string",
    "area": 0,
    "min_price": 0,
    "original_min_price": 0,
    "max_price": 0,
    "original_max_price": 0,
    "price_unit_in_days": 0
  }
]
```

--------------------------------

### GET https://api.lodgify.com/v1/availability

Source: https://docs.lodgify.com/reference/get_v1-availability

Retrieves availability information for all properties and room types associated with the authenticated user for a given date range.

```APIDOC
## GET https://api.lodgify.com/v1/availability

### Description
Retrieves availability information for all properties and room types associated with the authenticated user for a given date range.

### Method
GET

### Endpoint
https://api.lodgify.com/v1/availability

### Parameters
#### Query Parameters
- **periodStart** (date-time) - Required - The start date of the period to check availability.
- **periodEnd** (date-time) - Required - The end date of the period to check availability.
- **CombineRoomTypes** (boolean) - Optional - Indicates whether to combine results from different room types into a single house total.
- **BookingsOnly** (boolean) - Optional - Indicates whether to retrieve only booking information, excluding other availability details. This option is only valid for room type queries.
- **IncludeBookingIds** (boolean) - Optional - Indicates whether to include the list of booking identifiers in the response. This option is only valid for room type queries.
- **ModifiedSince** (date-time) - Optional - Filters the results to include only sub-periods modified after the specified date, up to 6 months prior to the current date. This option is only valid for room type queries.

### Response
#### Success Response (200)
- **property_id** (int32) - The unique identifier of the property associated with this availability period
- **room_type_id** (int32) - The unique identifier of the room type
- **period_start** (date-time) - The start date of the availability period
- **period_end** (date-time) - The end date of the availability period (inclusive)
- **available** (int32) - The number of units available during this period
- **total_units** (int32) - The total number of units for this room type
- **total_overbooked** (int32) - The total number of overbooked units for this room type
- **is_available** (boolean) - Indicates whether the period is available (not closed and has unoccupied units)
- **booking_ids** (array of int32s) - The list of booking identifiers associated with this period
- **closed_period_id** (int32) - The identifier of the closed period, if applicable

#### Response Example
[
  {
    "property_id": 0,
    "room_type_id": 0,
    "period_start": "2026-08-10T07:00:50.228Z",
    "period_end": "2026-08-10T07:00:50.228Z",
    "available": 0,
    "total_units": 0,
    "total_overbooked": 0,
    "is_available": true,
    "booking_ids": [0],
    "closed_period_id": 0
  }
]
```

--------------------------------

### GET /v2/rates/calendar

Source: https://docs.lodgify.com/reference/rates-1

Retrieves the calendar rates and settings for a specific property and room type within a given date range.

```APIDOC
## GET /v2/rates/calendar

### Description
Retrieves calendar items including pricing and rate settings for a specified house and room type.

### Method
GET

### Endpoint
https://api.lodgify.com/v2/rates/calendar

### Parameters
#### Query Parameters
- **houseId** (integer) - Required - The ID of the house.
- **roomTypeId** (integer) - Required - The ID of the room type.
- **startDate** (string) - Required - The start date in yyyy-MM-dd format.
- **endDate** (string) - Required - The end date in yyyy-MM-dd format.

### Response
#### Success Response (200)
- **calendar_items** (array) - List of daily calendar data.
- **rate_settings** (object) - Configuration settings for rates including currency, VAT, and fees.

#### Response Example
{
  "calendar_items": [
    {
      "date": "string",
      "is_default": true,
      "prices": [
        {
          "min_stay": 0,
          "max_stay": 0,
          "price_per_day": 123.45,
          "price_per_additional_guest": 123.45,
          "additional_guests_starts_from": 0
        }
      ]
    }
  ],
  "rate_settings": {
    "bookability": 0,
    "check_in_hour": 0,
    "check_out_hour": 0,
    "booking_window_days": 0,
    "advance_notice_days": 0,
    "advance_notice_hours": 0,
    "preparation_time_days": 0,
    "currency_code": "string",
    "vat": 0,
    "is_vat_exclusive": true,
    "fees": []
  }
}
```

--------------------------------

### Request Payment cURL Example

Source: https://docs.lodgify.com/reference/put_v1-reservation-booking-id-request-payment-1

Use this cURL command to trigger a payment request for a booking. Replace 'id' with the actual booking identifier.

```bash
curl --request PUT \
     --url https://api.lodgify.com/v1/reservation/booking/id/request_payment \
     --header 'accept: application/json'
```
Tokens:
Raw