GET
/
api
/
v1
/
listing
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "providerID": "provider-listing-12345",
      "integrationAccountID": "123e4567-e89b-12d3-a456-426614174000",
      "is_tenant_owned": true,
      "name": "Luxury Beach Villa",
      "internalName": "<HOST> Luxury Beach Villa",
      "description": "Beautiful beachfront villa with stunning views",
      "type": "Villa",
      "thumbnailURL": "https://example.com/thumbnail.jpg",
      "pictures": [
        {
          "url": "https://example.com/picture.jpg",
          "description": "A beautiful picture of the listing"
        }
      ],
      "address": {
        "city": "Miami Beach",
        "line1": "123 Ocean Drive",
        "state": "FL",
        "country": "USA",
        "postal_code": "70078"
      },
      "latitude": -80.1918,
      "longitude": 25.7617,
      "minimumNights": 3,
      "maximumNights": 28,
      "maxOccupancy": 10,
      "startPrice": 10,
      "currency": "AED",
      "timeZone": "Asia/Dubai",
      "status": "ACTIVE",
      "rating": {
        "count": 23,
        "average": 4.2
      },
      "bedroomCount": 3,
      "bathroomCount": 3,
      "rooms": {
        "data": [
          {
            "name": "SLEEPING_ALCOVE",
            "count": 1
          },
          {
            "name": "LIVING-DINING_ROOM",
            "count": 1
          }
        ]
      },
      "checkIn": {
        "op": "CHECK_IN",
        "end": "18:00:00",
        "start": "16:00:00"
      },
      "checkOut": {
        "op": "CHECK_IN",
        "end": "15:00:00"
      },
      "houseRules": {},
      "listingDetails": {
        "notes": "",
        "rules": "House rules are NON-negotiable conditions of stay. Any violation of our house rules will result in the immediate cancellation of your reservation, without refund, and your removal from the property.",
        "space": "",
        "access": "",
        "transit": "",
        "interaction": "",
        "instructions": "",
        "neighborhood": ""
      },
      "contact": {
        "name": "John Doe",
        "firstName": "John",
        "lastName": "Doe",
        "email": [
          "john.doe@example.com"
        ],
        "phone": [
          "+1234567890"
        ],
        "address": "123 Main St, Anytown, USA",
        "language": "en",
        "country": "USA"
      },
      "units": 3,
      "parentPropertyID": "<string>",
      "amenities": {
        "categories": {
          "Common Amenities": {
            "categoryID": "common",
            "values": [
              {
                "name": "Wifi",
                "id": "amenity-123"
              },
              {
                "name": "Kitchen",
                "id": "amenity-123"
              },
              {
                "name": "Iron",
                "id": "amenity-123"
              },
              {
                "name": "Pet friendly",
                "id": "amenity-123"
              },
              {
                "name": "Bed linens",
                "id": "amenity-123"
              }
            ]
          },
          "Outdoor": {
            "categoryID": "outdoor",
            "values": [
              {
                "name": "Smoking allowed",
                "id": "amenity-123"
              }
            ]
          }
        }
      },
      "rawAmenities": [
        {
          "id": 3,
          "name": "Wireless"
        },
        {
          "id": 6,
          "name": "Swimming pool"
        },
        {
          "id": 7,
          "name": "Kitchen"
        },
        {
          "id": 13,
          "name": "Washing Machine"
        },
        {
          "id": 30,
          "name": "Shampoo"
        },
        {
          "id": 32,
          "name": "Iron"
        },
        {
          "id": 33,
          "name": "Laptop Friendly workspace"
        },
        {
          "id": 34,
          "name": "TV"
        },
        {
          "id": 36,
          "name": "Smoking allowed"
        },
        {
          "id": 37,
          "name": "Pets allowed"
        },
        {
          "id": 41,
          "name": "Suitable for events"
        }
      ],
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-02T00:00:00.000Z"
    }
  ],
  "meta": {
    "total": 100,
    "limit": 15,
    "totalPages": 8,
    "current": 2,
    "previous": 1,
    "next": 3
  }
}

Authorizations

x-calry-api-key
string
header
required

Headers

x-calry-tenant-id
string

Optional tenant ID to specify which tenant to operate as. If not provided, the default tenant will be used.

Query Parameters

displayCurrency
string

Currency code for displaying pricing (ISO 4217)

Example:

"USD"

integrationAccountID
string

Filter listings by integration account ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

status
enum<string>

Filter listings by status

Available options:
ACTIVE,
INACTIVE
listingType
enum<string>

Filter by listing source

Available options:
imported,
self
guests
number

Minimum number of guests the listing can accommodate

Required range: 1 <= x <= 100
Example:

4

bedroomCount
number

Number of bedrooms

Required range: 0 <= x <= 20
Example:

2

bathroomCount
number

Number of bathrooms

Required range: 0 <= x <= 20
Example:

2

amenities
string[]

Array of amenity IDs to filter by

Example:
["wifi", "pool"]
location
string

Location coordinates in format "latitude,longitude"

Example:

"37.7749,-122.4194"

radius
number

Search radius in kilometers

Required range: 0.1 <= x <= 100
Example:

5

page
number

Page number for pagination

Required range: x >= 1
limit
number

Number of items per page

Required range: 1 <= x <= 100

Response

200
application/json

Listings retrieved successfully

The response is of type object.