Structure & Terms

This page outlines some high level terms and structures that are important for any API client to understand before diving into an integration

Workspaces

Within our Property Management System (PMS), a workspace serves as the central hub where users manage multiple buildings. It's the primary interface for:

• Daily operational tasks associated with building management.

• Configuring integrations with third-party systems, including but not limited to, DocuSign, Airbnb, and Stripe.

For detailed insights into authentication and access control related to workspaces, please refer to the Auth.

Many customers often manage multiple workspaces. It's also a common practice for customers to dedicate a single building to each workspace.

Buildings

A building comprises:

• Rooms or Units: These are spaces reserved for guests or residents.

• Facilities: Non-residential areas such as offices, meeting rooms, gyms, pools, etc.

Every building is:

• Associated with a unique set of data points. Explore the building queries for specific details.

• Aligned with a single workspace and cannot be linked to multiple workspaces.

Unit Types

A building encompasses various unit types, which define the layout or style of rooms. Think of a unit type as a template for rooms, e.g., "2 Bedroom Deluxe with terrace."

However, the definition of a unit type is flexible:

• It's determined by the customer setting up the inventory.

• One might define a unit type for each floor, while another could categorize inventory based on the duration of stay (short-term vs. long-term).

Units

A unit represents a specific instance of a unit type. For instance, using the "2 Bedroom Deluxe" type as an example, there might be five units named "2 Bedroom Deluxe - Room 3A", "2 Bedroom Deluxe - Room 3B", and so on.

Each unit features:

• A unique calendar.

• Distinct availability parameters.