EscapeLifeDocs
Available now

Properties

A Property is the top-level entity in EscapeLife. Every other resource — guests, bookings, knowledge sources, AI sessions — belongs to a property. Each API key is scoped to exactly one property.

The Property object

idstringUnique property ID. Prefixed pty_.
namestringDisplay name of the property.
slugstringURL-safe identifier. Unique across all properties.
typestringProperty type: resort, hotel, timeshare, golf, vacation_rental, campground, glamping.
timezonestringIANA timezone, e.g. America/New_York. Defaults to UTC.
currencystringISO 4217 currency code, e.g. USD. Defaults to USD.
countrystring | nullISO 3166-1 alpha-2 country code, e.g. US.
settingsobjectArbitrary property-level configuration key/value store.
is_activebooleanWhether the property is active. Inactive properties cannot accept new bookings.
created_atdatetimeISO 8601 timestamp.
updated_atdatetimeISO 8601 timestamp.

Endpoints

GET/v1/propertiesList properties

Return all properties accessible to this API key. Currently one property per key.

bash
curl https://api.escapelife.ai/v1/properties \
  -H "Authorization: Bearer sk_live_xxx"
Response
{
  "data": [
    {
      "id": "pty_xyz123",
      "name": "Grand Sunset Resort",
      "slug": "grand-sunset-resort",
      "type": "resort",
      "timezone": "America/New_York",
      "currency": "USD",
      "country": "US",
      "settings": {},
      "is_active": true,
      "created_at": "2026-03-01T00:00:00Z",
      "updated_at": "2026-03-15T10:00:00Z"
    }
  ]
}
GET/v1/properties/{property_id}Get a property

Retrieve a single property by ID or slug.

Path / Query Parameters

property_idstringrequiredProperty ID (pty_...) or slug.
PUT/v1/properties/{property_id}Update a property

Update property metadata. All fields are optional — only fields included in the request body will be modified.

Path / Query Parameters

property_idstringrequiredProperty ID (pty_...) or slug.

Request Body

namestringDisplay name.
timezonestringIANA timezone string.
currencystringISO 4217 currency code.
countrystringISO 3166-1 alpha-2 country code.
settingsobjectArbitrary configuration object.
is_activebooleanSet to false to deactivate the property.
bash
curl -X PUT https://api.escapelife.ai/v1/properties/pty_xyz123 \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"timezone": "America/Los_Angeles", "currency": "USD"}'

Property types

resorthoteltimesharegolfvacation_rentalcampgroundglampingspamarinaski

Webhooks fired by this module

property.updated

Fired when a property record is modified.

property.deactivated

Fired when is_active is set to false.