Properties

A property is one rental unit. Its record holds the unit’s details, door-code and guest-portal settings, and four operational status tracks: readiness, cleaning, inspection and maintenance. This guide covers the property operations most integrations need. Every field and filter is listed on the operation’s page in the API Reference.

Operation	Request	Permission
`listProperties`	`GET /properties`	`view_properties`
`getProperty`	`GET /properties/{id}`	`view_properties`
`updateProperty`	`PATCH /properties/{id}`	`modify_properties`
`updatePropertyStatus`	`POST /properties/{id}/status`	`modify_properties`
`assignPortalToProperty`	`POST /properties/{propertyId}/assign-portal`	`modify_properties`
`listPropertyTags`	`GET /properties/{propertyId}/tags`	`view_properties`
`listUpsellsByProperty`	`GET /properties/{propertyId}/upsells`	`view_properties`
`listPortalManualsByProperty`	`GET /properties/{propertyId}/portal-manuals`	`view_guides`

Paths are relative to your region’s base URL, for example https://api-us.suiteop.com/api/v1. See Authentication for permissions. Properties can’t be created or deleted through the API.

Listing properties

GET /properties is paginated (default limit 50, maximum 500). Rows are ordered by the unit’s nickname, or its name where it has no nickname.

curl "https://api-us.suiteop.com/api/v1/properties?cleaningStatuses=dirty&readinessStatuses=not_ready&limit=100" \
  -H "Authorization: Bearer sk_live_your_key_here"

Filters combine with AND. Each status filter matches any of the values you give; repeat the key for several values.

Filter	Notes
`readinessStatuses`	`ready`, `not_ready`, `occupied`, `unknown`. Derived from the other three tracks plus whether a guest is checked in
`cleaningStatuses`	`clean`, `dirty`, `unknown`. `occupied` is deprecated and only matches legacy rows
`inspectionStatuses`	`inspected`, `not_inspected`, `failed_inspection`, `inspection_waived`
`maintenanceStatuses`	`normal`, `attention_needed`, `blocked`. Derived from open maintenance tasks
`nameContains`	Case- and accent-insensitive match on name, nickname, city or state. Matched literally: `%` and `_` are not wildcards
`propertyGroupId`	Only properties in this group. `ungroupedOnly=true` keeps only ungrouped ones, and is ignored when `propertyGroupId` is set
`excludePropertyGroupId`	Drops properties already in this group, keeping ungrouped ones
`propertyIds`, `tagIds`	Restrict to these IDs, or to properties carrying at least one of these tags (`listTags`)
`includeDisabled`	Disabled properties are hidden by default
`archivedOnly`	Returns only archived properties, those deleted in the dashboard. No single call returns archived and live properties together

Each row carries fields such as id, name, nickname, unitNumber, city, state, countryCode, bedroomCount, bathroomCount, maxGuests, propertyGroupId, ownerId, portalSettingsId, isDisabled and the four status fields.

GET /properties/{id} returns the record, including the address, timezone, default check-in and check-out hours, wifiName, codeDisplay, the guest-portal flags and internalAccessNotes. A property outside the caller’s reach returns 404.

Secrets are write-only. wifiPassword, codeEntryKey, codeValidationKey, groupCodeEntryKey and groupCodeValidationKey can be set with updateProperty but no operation returns them.

GET /properties/{id} also does not return these writable fields: description, houseRules, checkInDescription, customAddress, addressOverride, isUnitCodeDisabled, isWifiHidden, defaultCheckInMinute and defaultCheckOutMinute. Keep your own copy if you need to read them back.

Updating a property

PATCH /properties/{id} takes the fields to change inside a data object. Fields you leave out keep their current value; most nullable fields take null to clear them.

curl -X PATCH https://api-us.suiteop.com/api/v1/properties/9a3d7e40-… \
  -H "Authorization: Bearer sk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"data": {"wifiName": "Loft-Guest", "wifiPassword": "sunny-2026", "maxGuests": 4}}'

The response is the updated property, without the secrets.

Field notes:

Guest texts: description, houseRules and checkInDescription take plain English text. It overwrites the English copy, and the organization’s other languages then follow from it. Only checkInDescription has a length limit, 150 characters. The response returns descriptionId, houseRulesId and checkInDescriptionId, translation IDs rather than text. Resending the stored text or an empty string changes nothing; to clear one, set its …Id field to null.
ownerId links the unit to one of the organization’s owner records, and null unassigns it. Owners are managed in the app; the API can’t list or create them.
isUnitCodeDisabled: true revokes the unit door code, not just hides it. Managed codes on the unit’s lock are retired and a delete is requested, including for guests mid-stay, though some codes can survive. The building code is unaffected. Set it back to false to resume.
customAddress is the address shown to guests on the portal and in automated email instead of the real one. addressOverride is not an address: it’s an https URL that replaces the map link behind the address.
timezone is re-resolved from the coordinates when you send both latitude and longitude without a timezone.
coverImageUrl: replacing or clearing it deletes the previously stored file.
reviewRequestOverrides replaces the whole per-channel map with what you send.
Operational status and the assigned portal can’t be changed here. Use updatePropertyStatus and assignPortalToProperty.

Setting cleaning and inspection status

POST /properties/{id}/status sets one of the two declarable tracks. field, value and trigger are required:

curl -X POST https://api-us.suiteop.com/api/v1/properties/9a3d7e40-…/status \
  -H "Authorization: Bearer sk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"field": "cleaningStatus", "value": "clean", "trigger": "cleaning_declared"}'

field is cleaningStatus (values clean, dirty, unknown) or inspectionStatus (values inspected, not_inspected, failed_inspection, inspection_waived). A value from the other field’s set is rejected.
Either write recomputes readiness. Sending the current value writes nothing.
trigger records why the status changed; it doesn’t perform the named action. Use cleaning_declared or inspection_declared for an outcome a person declared. With checkout or reservation_cancelled, the write is skipped while another guest is still checked in. Pass reservationId to exclude that stay from the check.
Maintenance and readiness can’t be set: a field of maintenanceStatus or readinessStatus is rejected with 400 validation_error rather than saved. Maintenance follows open maintenance tasks, and readiness follows reservations and these writes.

The response is the full property, not the status change.

Assigning a guest portal

POST /properties/{propertyId}/assign-portal puts an existing guest portal on one property:

curl -X POST https://api-us.suiteop.com/api/v1/properties/9a3d7e40-…/assign-portal \
  -H "Authorization: Bearer sk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"portalSettingsId": "c41e…"}'

portalSettingsId is the id returned by listPortals. Pass null to leave the property without a portal. The portal must belong to your organization. An OAuth token limited to some properties can only assign a portal it can already see, the organization’s default portal, or a portal serving no property; anything else returns 403.

Reading what a property carries

Three reads resolve what is attached to one property. None is paginated.

GET /properties/{propertyId}/tags returns the property’s tags as id and title. Use listTags for every tag in the organization.
GET /properties/{propertyId}/upsells returns the upsells that reach the property directly, through its group, through its guest portal or through a tag, deduplicated. assignmentLevel says which route applied. Archived upsells are left out. Titles aren’t included; call getUpsell for those.
GET /properties/{propertyId}/portal-manuals needs view_guides. It returns the house manuals assigned directly, through the group or through a tag, including inactive ones and without applying visibility rules, so it’s a superset of what a guest sees.

For a property outside your reach, the upsell and manual lists come back empty rather than as a 404.