Properties

name

string · required

id

string | null · uuid

account_id

string | null · uuid

address

string | null

city

string | null

zip_code

string | null

country

string | null

country_id

string | null · uuid

country_code

string | null

province_id

string | null · uuid

city_id

string | null · uuid

checkin_time

string | null

checkout_time

string | null

ses_establishment_code

string | null

ses_establishment_type

string | null

has_internet

boolean | null

rooms_count

integer | null

cover_image_url

string | null

role

string | null

POST/v1/properties

curl /v1/properties \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "address": "address",
  "city": "city",
  "zip_code": "zip_code",
  "airbnb_ical_url": "airbnb_ical_url",
  "booking_ical_url": "booking_ical_url",
  "default_cleaner_id": "00000000-0000-0000-0000-000000000000",
  "ses_establishment_code": "ses_establishment_code",
  "ses_establishment_type": "ses_establishment_type",
  "has_internet": true,
  "rooms_count": 0,
  "country_code": "country_code",
  "province_id": "00000000-0000-0000-0000-000000000000",
  "city_id": "00000000-0000-0000-0000-000000000000",
  "checkin_time": "checkin_time",
  "checkout_time": "checkout_time"
}'

Example Request Body

{
  "name": "name",
  "address": "address",
  "city": "city",
  "zip_code": "zip_code",
  "airbnb_ical_url": "airbnb_ical_url",
  "booking_ical_url": "booking_ical_url",
  "default_cleaner_id": "00000000-0000-0000-0000-000000000000",
  "ses_establishment_code": "ses_establishment_code",
  "ses_establishment_type": "ses_establishment_type",
  "has_internet": true,
  "rooms_count": 0,
  "country_code": "country_code",
  "province_id": "00000000-0000-0000-0000-000000000000",
  "city_id": "00000000-0000-0000-0000-000000000000",
  "checkin_time": "checkin_time",
  "checkout_time": "checkout_time"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "address": "address",
  "city": "city",
  "zip_code": "zip_code",
  "country": "country",
  "country_id": "00000000-0000-0000-0000-000000000000",
  "country_code": "country_code",
  "province_id": "00000000-0000-0000-0000-000000000000",
  "city_id": "00000000-0000-0000-0000-000000000000",
  "checkin_time": "checkin_time",
  "checkout_time": "checkout_time",
  "ses_establishment_code": "ses_establishment_code",
  "ses_establishment_type": "ses_establishment_type",
  "has_internet": true,
  "rooms_count": 0,
  "default_cleaner": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "last_name": "last_name",
    "email": "email",
    "access_level": "access_level",
    "service": "service"
  },
  "cover_image_url": "cover_image_url",
  "role": "role",
  "calendars": [
    {
      "channel": "channel",
      "url": "url",
      "syncIntervalMinutes": 0,
      "lastSyncAt": "2024-08-25",
      "lastError": "lastError"
    }
  ],
  "smart_locks": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "vendor": "vendor",
      "name": "name"
    }
  ],
  "team": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "last_name": "last_name",
      "email": "email",
      "access_level": "access_level",
      "service": "service"
    }
  ]
}

json

application/json

Get property

GET

/v1/properties/{id}

Get property › path Parameters

id

string · required

Property id

Get property › Responses

The property with its calendars, smart locks, team, and default cleaner. Sensitive fields are redacted for non-owner roles.

name

string · required

id

string | null · uuid

account_id

string | null · uuid

address

string | null

city

string | null

zip_code

string | null

country

string | null

country_id

string | null · uuid

country_code

string | null

province_id

string | null · uuid

city_id

string | null · uuid

checkin_time

string | null

checkout_time

string | null

ses_establishment_code

string | null

ses_establishment_type

string | null

has_internet

boolean | null

rooms_count

integer | null

cover_image_url

string | null

role

string | null

GET/v1/properties/{id}

curl /v1/properties/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "address": "address",
  "city": "city",
  "zip_code": "zip_code",
  "country": "country",
  "country_id": "00000000-0000-0000-0000-000000000000",
  "country_code": "country_code",
  "province_id": "00000000-0000-0000-0000-000000000000",
  "city_id": "00000000-0000-0000-0000-000000000000",
  "checkin_time": "checkin_time",
  "checkout_time": "checkout_time",
  "ses_establishment_code": "ses_establishment_code",
  "ses_establishment_type": "ses_establishment_type",
  "has_internet": true,
  "rooms_count": 0,
  "default_cleaner": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "last_name": "last_name",
    "email": "email",
    "access_level": "access_level",
    "service": "service"
  },
  "cover_image_url": "cover_image_url",
  "role": "role",
  "calendars": [
    {
      "channel": "channel",
      "url": "url",
      "syncIntervalMinutes": 0,
      "lastSyncAt": "2024-08-25",
      "lastError": "lastError"
    }
  ],
  "smart_locks": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "vendor": "vendor",
      "name": "name"
    }
  ],
  "team": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "last_name": "last_name",
      "email": "email",
      "access_level": "access_level",
      "service": "service"
    }
  ]
}

json

application/json

Update property

PUT

/v1/properties/{id}

Replaces mutable property fields and re-syncs the Airbnb and Booking.com iCal integrations based on the supplied URLs (set to null to remove an integration).

Update property › path Parameters

id

string · required

Property id

Update property › Request Body

NewPropertyRequest

name

string · required

address

string · required

zip_code

string · required

city

string | null

airbnb_ical_url

string | null

booking_ical_url

string | null

default_cleaner_id

string | null · uuid

ses_establishment_code

string | null

ses_establishment_type

string | null

has_internet

boolean | null

rooms_count

integer | null

country_code

string | null

province_id

string | null · uuid

city_id

string | null · uuid

checkin_time

string | null

checkout_time

string | null

Update property › Responses

The updated property

name

string · required

id

string | null · uuid

account_id

string | null · uuid

address

string | null

city

string | null

zip_code

string | null

country

string | null

country_id

string | null · uuid

country_code

string | null

province_id

string | null · uuid

city_id

string | null · uuid

checkin_time

string | null

checkout_time

string | null

ses_establishment_code

string | null

ses_establishment_type

string | null

has_internet

boolean | null

rooms_count

integer | null

cover_image_url

string | null

role

string | null

PUT/v1/properties/{id}

curl /v1/properties/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "address": "address",
  "city": "city",
  "zip_code": "zip_code",
  "airbnb_ical_url": "airbnb_ical_url",
  "booking_ical_url": "booking_ical_url",
  "default_cleaner_id": "00000000-0000-0000-0000-000000000000",
  "ses_establishment_code": "ses_establishment_code",
  "ses_establishment_type": "ses_establishment_type",
  "has_internet": true,
  "rooms_count": 0,
  "country_code": "country_code",
  "province_id": "00000000-0000-0000-0000-000000000000",
  "city_id": "00000000-0000-0000-0000-000000000000",
  "checkin_time": "checkin_time",
  "checkout_time": "checkout_time"
}'

Example Request Body

{
  "name": "name",
  "address": "address",
  "city": "city",
  "zip_code": "zip_code",
  "airbnb_ical_url": "airbnb_ical_url",
  "booking_ical_url": "booking_ical_url",
  "default_cleaner_id": "00000000-0000-0000-0000-000000000000",
  "ses_establishment_code": "ses_establishment_code",
  "ses_establishment_type": "ses_establishment_type",
  "has_internet": true,
  "rooms_count": 0,
  "country_code": "country_code",
  "province_id": "00000000-0000-0000-0000-000000000000",
  "city_id": "00000000-0000-0000-0000-000000000000",
  "checkin_time": "checkin_time",
  "checkout_time": "checkout_time"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "address": "address",
  "city": "city",
  "zip_code": "zip_code",
  "country": "country",
  "country_id": "00000000-0000-0000-0000-000000000000",
  "country_code": "country_code",
  "province_id": "00000000-0000-0000-0000-000000000000",
  "city_id": "00000000-0000-0000-0000-000000000000",
  "checkin_time": "checkin_time",
  "checkout_time": "checkout_time",
  "ses_establishment_code": "ses_establishment_code",
  "ses_establishment_type": "ses_establishment_type",
  "has_internet": true,
  "rooms_count": 0,
  "default_cleaner": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "last_name": "last_name",
    "email": "email",
    "access_level": "access_level",
    "service": "service"
  },
  "cover_image_url": "cover_image_url",
  "role": "role",
  "calendars": [
    {
      "channel": "channel",
      "url": "url",
      "syncIntervalMinutes": 0,
      "lastSyncAt": "2024-08-25",
      "lastError": "lastError"
    }
  ],
  "smart_locks": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "vendor": "vendor",
      "name": "name"
    }
  ],
  "team": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "last_name": "last_name",
      "email": "email",
      "access_level": "access_level",
      "service": "service"
    }
  ]
}

json

application/json

Delete property

DELETE

/v1/properties/{id}

Delete property › path Parameters

id

string · required

Property id

Delete property › Responses

Property deleted

No data returned

Partially update property

PATCH

/v1/properties/{id}

Applies a JSON Merge Patch–style partial update. Only fields supplied in the body are changed; absent fields are left untouched. Geo fields (country/province/city) and airbnb_ical_url are not supported here — use PUT for those.

Partially update property › path Parameters

id

string · required

Property id

Partially update property › Request Body

PropertyPatch

name

string | null

address

string | null

zip_code

string | null

default_cleaner_id

string | null · uuid

ses_establishment_code

string | null

ses_establishment_type

string | null

has_internet

boolean | null

rooms_count

integer | null

checkin_time

string | null

checkout_time

string | null

Partially update property › Responses

The updated property

name

string · required

id

string | null · uuid

account_id

string | null · uuid

address

string | null

city

string | null

zip_code

string | null

country

string | null

country_id

string | null · uuid

country_code

string | null

province_id

string | null · uuid

city_id

string | null · uuid

checkin_time

string | null

checkout_time

string | null

ses_establishment_code

string | null

ses_establishment_type

string | null

has_internet

boolean | null

rooms_count

integer | null

cover_image_url

string | null

role

string | null