Properties

name

string · required

address

string · required

city

string · required

zip_code

string · required

airbnb_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

Create a property › Responses

The created 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

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/properties

curl --request POST \
  --url /properties \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "address": "address",
  "city": "city",
  "zip_code": "zip_code",
  "airbnb_ical_url": "airbnb_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
}
'

shell

Example Request Body

{
  "name": "name",
  "address": "address",
  "city": "city",
  "zip_code": "zip_code",
  "airbnb_ical_url": "airbnb_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
}

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",
  "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 a property by id

GET

/properties/{id}

Get a property by id › path Parameters

id

string · required

Property id

Get a property by id › 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

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/properties/{id}

curl --request GET \
  --url /properties/:id

shell

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",
  "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 a property

PUT

/properties/{id}

Replaces mutable property fields and re-syncs the Airbnb iCal integration based on the supplied URL (set to null to remove the integration).

Update a property › path Parameters

id

string · required

Property id

Update a property › Request Body

name

string · required

address

string · required

city

string · required

zip_code

string · required

airbnb_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

Update a 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

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

Integrations PropertyMembers

PUT/properties/{id}

curl --request PUT \
  --url /properties/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "address": "address",
  "city": "city",
  "zip_code": "zip_code",
  "airbnb_ical_url": "airbnb_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
}
'

shell

Example Request Body

{
  "name": "name",
  "address": "address",
  "city": "city",
  "zip_code": "zip_code",
  "airbnb_ical_url": "airbnb_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
}

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",
  "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 a property

DELETE

/properties/{id}

Delete a property › path Parameters

id

string · required

Property id

Delete a property › Responses

Property deleted

No data returned

Upload a cover image for a property

POST

/properties/{id}/cover-image

Multipart upload. Expects a single file part containing the image bytes. Only owners and managers may update the cover image.

Upload a cover image for a property › path Parameters

id

string · required

Property id

Upload a cover image for a property › Responses

The stored file metadata

FileResponse

id

string · uuid · required

url

string · required

original_filename

string · required

content_type

string · required

size_bytes

integer · required

Remove the cover image for a property

DELETE

/properties/{id}/cover-image

Remove the cover image for a property › path Parameters

id

string · required

Property id

Remove the cover image for a property › Responses

Cover image removed

No data returned

List properties accessible to the caller

GET

/properties

List properties accessible to the caller › query Parameters

page

string

Zero-based page index (default 0)

size

string

Page size (max 100)

List properties accessible to the caller › Responses

Paginated properties the caller owns or has crew access to

PropertiesResponse

Property[] · required

page

integer | null

size

integer | null

total

integer | null

Create a property

POST

/properties

Create a property › Request Body

name

string · required

address

string · required

city

string · required

zip_code

string · required

airbnb_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

Create a property › Responses

The created 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

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 a property by id

GET

/properties/{id}

Get a property by id › path Parameters

id

string · required

Property id

Get a property by id › 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

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

Update a property

PUT

/properties/{id}

Replaces mutable property fields and re-syncs the Airbnb iCal integration based on the supplied URL (set to null to remove the integration).

Update a property › path Parameters

id

string · required

Property id

Update a property › Request Body

name

string · required

address

string · required

city

string · required

zip_code

string · required

airbnb_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

Update a 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

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