Media

Return detailed information for property media.

API: Direct Booking · Operation: Property Media · Direction: SM → Property · Method: Pull (Property-initiated)

Retrieve a property's media

get

Retrieve every image a property has, grouped by where it's used: the property banner, property-level photos, the header and footer images used in guest communication emails, and room type and extra photos.

sortOrder only appears on photos, and gives each photo's position in the gallery, starting at 1. A photo with no set position has sortOrder: null.

roomTypes.photos and extras.photos list the photos used across the property's room types and extras, with duplicates removed — they aren't tied to a specific room type or extra.

Authorizations

x-sm-api-keystringRequired

Path parameters

propertyUuidstringRequired

UUID for a property.

Header parameters

x-sm-api-keystringRequired

API key used to authenticate the request.

Responses

200

Successful operation

application/json

401

Not Authorised

application/json

403

Access Denied

application/json

404

The specified resource was not found

application/json

429

Rate Limited

application/json

500

Internal Server Error

application/json

get/properties/{propertyUuid}/media

GET /properties/{propertyUuid}/media HTTP/1.1
x-sm-api-key: text
Accept: */*

{
  "banner": {
    "url": "https://example.com/banner.jpg"
  },
  "photos": [
    {
      "url": "https://example.com/photo1.jpg",
      "caption": "Hotel exterior at dusk",
      "sortOrder": 1
    }
  ],
  "guestCommunications": {
    "reservationConfirmation": {
      "header": {
        "url": "https://example.com/header.jpg"
      },
      "footer": null
    },
    "reservationModification": {
      "header": null,
      "footer": null
    },
    "reservationCancellation": {
      "header": null,
      "footer": null
    },
    "preArrival": {
      "header": null,
      "footer": null
    },
    "postDeparture": {
      "header": null,
      "footer": null
    }
  },
  "roomTypes": {
    "photos": [
      {
        "url": "https://example.com/room.jpg",
        "caption": "Deluxe king, city view"
      }
    ]
  },
  "extras": {
    "photos": [
      {
        "url": "https://example.com/extra.jpg",
        "caption": "Airport transfer"
      }
    ]
  }
}

Still have questions?

Use the Ask button at the top of the page to chat with our AI assistant — it can help you navigate the guide, understand requirements, and troubleshoot issues.

If you need more support, visit Integration Support.