Properties

Return a list of properties in your group, or return detailed information for a specific property contained in your group.

Paginates all properties based on permissions

get

Retrieve the uuid and name for all properties which you have access to

Authorizations

apiKey

x-sm-api-keystringRequired

Query parameters

pageinteger · min: 1Optional

page number (defaults to 1)

perPageinteger · min: 1 · max: 50Optional

items per page (defaults to 10)

Header parameters

x-sm-api-keystringRequired

access token retrieved from Multi-Property Platform

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

get

/properties

HTTPcURLJavaScriptPython

GET /properties HTTP/1.1
Host: 
x-sm-api-key: text
Accept: */*

{
  "results": [
    {
      "uuid": "f63ce398-da03-4573-856d-ed8d71e57e3d",
      "name": "Demo Hotel"
    }
  ],
  "page": 1,
  "perPage": 1,
  "total": 1,
  "totalPages": 1
}

Retrieve property details

get

Retrieve detailed information for a property.

Authorizations

apiKey

x-sm-api-keystringRequired

Path parameters

propertyUuidstringRequired

uuid for a property

Header parameters

x-sm-api-keystringRequired

access token retrieved from Multi-Property Platform

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

get

/properties/{propertyUuid}

HTTPcURLJavaScriptPython

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

{
  "uuid": "f63ce398-da03-4573-856d-ed8d71e57e3d",
  "name": "Demo Hotel",
  "latitude": -33.8688197,
  "longitude": 151.2092955,
  "timezoneId": "Australia/Sydney",
  "currencyIsoCode": "AUD",
  "bookingEngineUrl": "https://direct-book.com/properties/propertyChannelCode",
  "address": {
    "addressLine1": "88 Cumberland Street",
    "addressLine2": "Apartment",
    "postcode": "2000",
    "state": "NSW",
    "suburb": "The Rocks"
  }
}