Property

Get a properties list

Get the list of properties.<br>You need to be authorized (no particular scope required)

get/inventory/v1/properties

Query parameters

statusstring[]

Filter result by property status

includeArchivedboolean

Include archived properties in the result. If not set, or set to false, it only returns non-archived properties

countryCodestring[]

Filter result by country code

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.

Response

Return all properties.

countinteger required

Total count of items

Example response

{
  "properties": [
    {
      "id": "MUC",
      "code": "MUC",
      "isTemplate": true,
      "name": "Demo Hotel Munich",
      "description": "This is the demo hotel Munich",
      "companyName": "Company",
      "commercialRegisterEntry": "CRE",
      "taxId": "Tax",
      "location": {
        "addressLine1": "Marienplatz 1",
        "postalCode": "80331",
        "city": "München",
        "countryCode": "DE"
      },
      "paymentTerms": {
        "de": "Zahlbar bei Check In",
        "en": "Payment on check-in"
      },
      "timeZone": "Europe/Berlin",
      "currencyCode": "EUR",
      "created": "0001-01-01T00:00:00Z",
      "status": "Test",
      "isArchived": false
    },
    {
      "id": "BER",
      "code": "BER",
      "propertyTemplateId": "MUC",
      "isTemplate": false,
      "name": "Demo Hotel Berlin",
      "description": "This is the demo hotel Berlin",
      "companyName": "Company",
      "commercialRegisterEntry": "CRE",
      "taxId": "Tax",
      "location": {
        "addressLine1": "Mohrenstraße 30",
        "postalCode": "10117",
        "city": "Berlin",
        "countryCode": "DE"
      },
      "paymentTerms": {
        "de": "Zahlbar bei Check In",
        "en": "Payment on check-in"
      },
      "timeZone": "Europe/Berlin",
      "currencyCode": "EUR",
      "created": "0001-01-01T00:00:00Z",
      "status": "Test",
      "isArchived": false
    }
  ],
  "count": 0
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.